Skip to content
Gallery
Repositório de documentação
Share
Explore

icon picker
Visão geral

🤷Porque?

Sem um motivo, não há necessidade de criar uma documentação de algo. De forma geral, esses são os principais:
Comunicação: Facilita o alinhamento interno e com outras áreas sobre novas features, mudanças de escopo e outras atualizações importantes.
Compartilhamento de conhecimento: A documentação não é pessoal, mas sim um recurso coletivo. Para garantir sua eficácia:
Nada é óbvio: Sempre explique e detalhe ao máximo.
Use uma linguagem clara e acessível: Mesmo em documentações técnicas, tente abordar as informações de forma que pessoas de diferentes áreas possam compreender.
Escalabilidade: Permite que várias pessoas acessem a mesma informação sem necessidade de múltiplas reuniões individuais para repassar o mesmo conteúdo.
Registro e rastreabilidade: Formaliza decisões, mudanças no escopo e novas definições, garantindo um histórico acessível.

🧐O que é?

É o conjunto de registros sobre os produtos da empresa e as respectivas áreas envolvidas no ciclo de desenvolvimento de produto.

⛱️Onde?

Toda documentação deve ser feita no Coda, dentro da pasta específica, seguindo a

👀Como?

Seguindo os padrões estabelecidos, qualquer formato de informação é bem-vindo.
Inclua prints e vídeos sempre que possível, pois facilitam a compreensão.

⏱️Quando fazer?

A documentação deve ser feita de forma contínua, em todas as fases do projeto ou produto. Quanto mais informações forem registradas, melhor.

🧚‍♂️Quem faz?

A responsabilidade pela documentação é coletiva: todas as pessoas envolvidas no time devem contribuir. No entanto, é essencial definir uma pessoa responsável pela manutenção, garantindo que as informações permaneçam atualizadas e organizadas.

Want to print your doc?
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.