Questões e Respostas
O que o Design Docs busca documentar?
- Registrar os principais conceitos das regras de negócio.
- Documentar a modelagem do banco de dados para futura implementação.
- Informar as principais vantagens e desvantagens de um produto.
- O documento de design documenta a estratégia de implementação de alto nível e as principais decisões de design com ênfase nas compensações que foram consideradas.
Quais são alguns dos principais objetivos do Design Docs?
- Antecipar todas as futuras features a serem implementadas, escalar conhecimento e ser acessado apenas pelos desenvolvedores.
- Produzir o máximo de informação possível, criar uma memória organizacional e ser acessado apenas pelos desenvolvedores.
- Gerar documentação extensiva, detalhada e formal, produzir o máximo de informação possível e antecipar todas as futuras features a serem implementadas.
- Identificar dos problemas precocemente, alcançar consenso no projeto, escalar conhecimento e criar uma memória organizacional.
Estas são algumas das recomendações apresentadas para o preenchimento da documentação.
- A base de código, testes unitário e visão geral.
- Rodapé, bibliografia, escopo e contexto.
- Cabeçalhos, visão geral, escopo, contexto, objetivos.
- Cabeçalhos, rodapé e testes realizados.
Não é necessário informar o que está fora do escopo, uma vez que a delimitação já foi estabelecida.
A documentação do design pode conter linguagem informal e usar diagramas para deixar a comunicação clara.
Algumas das ferramentas apresentadas para a criação do design docs são:
- Confluence, Google Docs, Github e PlantUML.
- Git, VS Code, Confluence e Google Chrome.
- Confluence, Google Docs e VS Code.
- Google Chrome, Google Docs e Git.
Estes são alguns casos em que não se deve escrever um Design Docs:
- Quando não há complexidade.
- Todas as opções.
- Quando há sobrecarga no processo.
- Cultura organizacional patológica.