Repositório para conter manifestos em markdown para aspectos de projetos, arquitetura, Prompts de IA, Diagramas, e outros documentos técnicos.
markdown-notes/
├── projetos/ # Manifestos e documentação de projetos
├── arquitetura/ # Documentos de arquitetura de software
├── prompts-ia/ # Prompts e guias para IA
├── diagramas/ # Diagramas e representações visuais
├── templates/ # Templates reutilizáveis
└── README.md # Este arquivo
Documentos relacionados a aspectos de projetos, incluindo:
- Visões de produto
- Roadmaps
- Requisitos
- Especificações técnicas
Documentação de arquitetura de software:
- Decisões arquiteturais (ADRs)
- Diagramas de arquitetura
- Padrões e práticas
- Design de sistemas
Coleção de prompts e guias para trabalhar com IA:
- Prompts para desenvolvimento
- Prompts para documentação
- Prompts para análise de código
- Melhores práticas
Diagramas técnicos e representações visuais:
- Diagramas de fluxo
- Diagramas de sequência
- Diagramas de componentes
- Diagramas C4
- Navegue até a categoria desejada
- Use os templates disponíveis em
templates/como ponto de partida - Crie novos documentos seguindo a estrutura existente
- Mantenha a nomenclatura clara e descritiva
Templates estão disponíveis na pasta templates/ para:
- ADR (Architecture Decision Record)
- Documento de Projeto
- Prompt de IA
- Diagrama
Para adicionar novos manifestos:
- Escolha a categoria apropriada
- Use ou adapte um template existente
- Nomeie o arquivo de forma descritiva
- Adicione metadados relevantes no início do documento
- Use markdown (.md) para todos os documentos
- Nomes de arquivo em lowercase com hífens (kebab-case)
- Inclua data no formato YYYY-MM-DD quando relevante
- Mantenha documentos concisos e focados