Projetos e Repositórios
Cada repositório de código-fonte deve incluir documentação específica para ele (por exemplo, em uma Wiki dentro do repositório), enquanto o projeto em si deve incluir documentação geral que seja comum a todos os seus repositórios associados (por exemplo, em uma Wiki dentro da ferramenta de gerenciamento de backlog).
Documentação específica para um repositório
- Introdução
- Primeiros passos
- Integração
- Configuração: linguagem de programação, frameworks, plataformas, ferramentas, etc.
- Ambiente de teste
- Acordo de trabalho
- Guia de contribuição
- Estrutura: pastas, projetos, etc.
- Como compilar, testar, construir, implantar a solução/cada projeto
- Diferentes versões do sistema operacional
- Linha de comando + editores/IDEs
- Logs de Decisão de Design
Algumas seções na documentação do repositório podem apontar para a documentação do projeto (por exemplo, Integração, Acordo de Trabalho, Guia de Contribuição).
Documentação comum a todos os repositórios
- Introdução
- Projeto
- Partes interessadas
- Definições
- Requisitos
- Integração
- Guia do repositório
- Produção, Spikes
- Acordos da equipe
- Manifesto da Equipe
- Resumo breve das expectativas em torno da forma técnica de trabalhar e da mentalidade apoiada na equipe.
- Por exemplo, propriedade, respeito, colaboração, transparência.
- Acordo de Trabalho
- Como trabalhamos juntos como equipe e quais são nossas expectativas e princípios.
- Por exemplo, comunicação, equilíbrio entre trabalho e vida, ritmo scrum, gerenciamento de backlog, gerenciamento de código.
- Definição de Pronto
- Lista de tarefas que devem ser concluídas para encerrar uma história de usuário, um sprint ou uma etapa.
- Definição de Pronto para Estimar
- Quão completa uma história de usuário deve estar para ser selecionada como candidata para estimativa no planejamento do sprint.
- Manifesto da Equipe
- Guia de Contribuição
- Design do Projeto
- Receitas de Revisão de Design