Como documentar seu fluxo conversacional

Olá a todes! :smileblip:

Voltei e hoje eu trouxe pra vocês um dos meus assuntos favoritos quando falamos sobre contatos inteligentes: Documentação de fluxos conversacionais

Primeiro, o que é documentação?

Quando falamos sobre documentação, estamos nos referindo a qualquer material textual que os times utilizam para realizar o seu trabalho.

Mas não somente isso: a documentação deve ser uma descrição precisa sobre o seu contato inteligente. Quanto maior a precisão desses documentos, maior o status de autoridade que eles podem ter.

“Uma boa documentação é aquela capaz de apoiar o time nas etapas de desenvolvimento, compreensão e manutenção do código.”

Por que criar documentações para seu fluxo conversacional?

:white_check_mark: São uma ótima fonte de informação

A documentação serve como uma fonte de informação do contato inteligente, por conter tudo o que é necessário para sua construção e manutenção, como por exemplo:

  • Arquitetura;
  • Skills contidas no chatbot;
  • Registros de alterações e etc.

:white_check_mark: Facilita futuras evoluções.

A documentação serve para auxiliar programadores, facilitando o uso e o entendimento do contato inteligente, principalmente quando ele precisa de evoluções. A documentação deve ser bem construída e ser de fácil entendimento.

:white_check_mark: Minimiza a possibilidade de retrabalhos

Ao herdar um contato inteligente, ter o histórico de desenvolvimento serve como base para que o desenvolvedor possa se situar, ver o que já foi feito e evoluir a partir disso.

Caso não haja um nível de detalhamento suficiente ou padrão de arquitetura, podemos perder tempo tentando entendê-lo e em certos momentos, acabamos refazendo algo já feito, acabando em retrabalhos que poderiam ter sido evitados.

Para além da evolução do contato inteligente, caso seja necessário reproduzir ou realizar manutenções, esse tipo de informação vale muito para a empresa, informações essas que não podem ser perdidas.

Ferramentas para usar na hora de documentar seu fluxo conversacional:

Quer saber mais detalhes sobre cada uma das ferramentas e como usá-las para documentar o seu fluxo conversacional? Vem dar uma olhada no slide da apresentação!

Lá eu dou detalhes sobre cada uma delas, trago imagens e vídeos para te ajudar a decidir qual a ferramenta ideal para documentar o seu fluxo conversacional.

Como documentar seu fluxo conversacional no Blip AMA

:curiousblip: Aqui você pode conferir a minha apresentação no Blip AMA#83

5 curtidas