Guia para documentação em system design em System Design
Prompt gerado automaticamente para Documentação em System Design em System Design
Crie um guia interativo e passo a passo para a elaboração de documentação técnica de System Design (arquitetura, APIs, infraestrutura) focando em **facilitar a atualização e a colaboração entre equipes multidisciplinares (desenvolvedores, SREs, QAs, gerentes de produto)**. O guia deve incluir:
1. **Modelos personalizáveis:** Ofereça templates para diferentes tipos de documentação (diagramas de fluxo de dados, especificações de API, decisões de arquitetura, runbooks de infraestrutura), com campos pré-definidos e exemplos de preenchimento.
2. **Boas práticas de versionamento e acessibilidade:** Explique como usar ferramentas de controle de versão (ex: Git) para documentação, integração com plataformas de colaboração (ex: Confluence, Notion, Docs como código), e estratégias para garantir que a informação seja facilmente encontrada e compreendida por diferentes públicos.
3. **Mecanismos para feedback e contribuição:** Proponha fluxos de trabalho para revisão de documentação, sugestão de melhorias e incorporação de novas informações, incentivando a ownership compartilhada.
4. **Integração com o ciclo de vida do desenvolvimento de software (SDLC):** Mostre como a documentação deve evoluir junto com o sistema, desde a concepção até a operação e desativação, e como automatizar a geração de partes da documentação (ex: a partir de código-fonte ou definições OpenAPI).
O objetivo é transformar a documentação de um "mal necessário" em uma **ferramenta viva e estratégica para a comunicação eficaz e a sustentabilidade do sistema**, reduzindo a fricção e o retrabalho.
Tags relacionadas
Como Usar este Prompt
Clique no botão "Copiar Prompt" para copiar o conteúdo completo.
Abra sua ferramenta de IA de preferência (ChatGPT e etc.).
Cole o prompt e substitua as variáveis (se houver) com suas informações.
Outros prompts de System Design
Continue explorando prompts nesta categoria.
Melhores práticas de debugging em system design para System Design
Prompt gerado automaticamente para Debugging em System Design em System Design
Melhores práticas de casos de uso práticos em system design para System Design
Prompt gerado automaticamente para Casos de uso práticos em System Design em System Design
Melhores práticas de casos de uso práticos em system design para System Design
Prompt gerado automaticamente para Casos de uso práticos em System Design em System Design