- Documentamos para ajudar os outros e a nós próprios : Para ensinar aos que não estão familiarizados com um sistema como ele é estruturado, criado e funciona.
- Para utilizar, operar, apoiar e manter o software ao longo do tempo.
- Para reflectir sobre o produto, ajudar a solidificar e descobrir aspectos que não foram contemplados.
- Para apoiar a comunicação com grupos externos e auditorias, como complemento de discussões presenciais, e-mails ou como complemento de discussões presenciais, e-mails ou ferramentas de colaboração.
- Liga o design e a codificação para fazer passar a mensagem ou para nos ajudar a não esquecer algo.
- Reduz o custo de manter o código legado que é difícil de compreender e evoluir.
- Deve estar actualizado, fácil de localizar , fácil de ler e interpretar .
- Documentação em Agile é um ser vivo É mantida leve e simples.
- Está escrito mesmo a tempo Quando é necessário, quando é necessário, antes de aumentar o risco de desatualização e retrabalho.
- A documentação está incluída no processo ágil, faz parte do esforço e do custo do produto.
- Faz parte do entrega contínua de software de trabalho.
- Documentar é um processo processo de colaboração onde cada membro da equipa contribui.
- Tenha um pessoa de referência que irá gerir o processo de documentação alguém que compreende as questões que precisam de ser abordadas e que gere o controlo de versões .
- Documentar o que ajuda a equipa a realizar o seu trabalho e aquilo que que acompanha o produto para utilização e manutenção. Alguns exemplos:
- Trabalho de equipa Membros da equipa, dados de comunicação, preferências e particularidades
- Acordos de equipa Definição de Pronto (DoR), Definição de Feito (DoD), Normas de Documentação, entre outros.
- Retrospectivas Resultados da dinâmica e das Acções de Melhoria, acompanhamento e análise dos resultados.
- Iniciar Doc. Ficha de produto ou projecto, Protótipos, Mapeamento de histórias de utilizadores, Requisitos de alto nível, …
- Documento Funcional do Produto. : Mapa do processo, Sistema de navegação, Guias do utilizador, …
- Documentação técnica do produto : Arquitectura do sistema, mapas de dados, serviços (APIs), guias de implantação, guias de instalação e operação de software.
Leia mais: DocOps – Mantenha a sua documentação ágil
Maria Esther Remedios
@soy.agile.coach
