Aula 08: Projeto Intermediário 🏗️
Consolidando Conhecimento de Elite 🏆
O que vamos aprender hoje? 🎯
- Consolidação de Módulos 🧱
- Interconexão de Documentos 🔗
- Design de Experiência (UX) 🎨
- Checklist de Lançamento ✅
- Apresentação do Desafio 🚀
1. Consolidação de Módulos 🧱
Já vimos: - Sintaxe Básica ✍️ - Organização de Arquivos 📂 - Markdown p/ Programadores 💻 - Tabelas e Requisitos 📊 - Integração com GitHub 🐙
2. Interconexão de Documentos 🔗
O segredo de um manual profissional.
Tudo deve estar a um clique de distância.
Use links relativos inteligentes.
3. Design de Experiência (UX) 🎨
Documentação também é design!
- Use espaços em branco.
- Destaque o que é crítico (Alertas).
- Menos texto, mais estrutura.
4. Checklist de Lançamento ✅
Sua documentação está pronta para o mundo?
- README.md com Badges?
- Links testados e funcionando?
- Código com destaque de sintaxe?
Erros Comuns para Evitar 🚫
- Falta de imagens/exemplos.
- Caminhos absolutos (C:\Users...).
- Erros de português.
- Falta de link de volta ao início.
5. O Grande Desafio 🚀
Documentar o TaskMaster CLI.
Um pequeno gestor de tarefas via terminal.
Veja os requisitos no diretório de projetos!
Estrutura do Desafio (Mermaid) 🧜♀️
mermaid mindmap root((TaskMaster CLI)) Intro O que e? Badges status Setup Instalaçao Requirements API Comandos Exemplos Social Contribuidores Feedback
Dica Técnica: Versionamento 🐚
Sempre que terminar uma grande parte da doc...
Dê um commit e crie uma Tag!
Exercício Rápido 🧠
O que deve ser a primeira coisa que o usuário vê?
A) O código fonte completo. B) O README.md com a visão geral. ✅ C) A lista de bugs.
Resumo do Módulo 📝
- Markdown transforma texto em valor.
- Estrutura é mais importante que decoração.
- GitHub é a casa oficial da sua doc.
Fim do Segundo Módulo! 🥈
Parabéns! Você já é um documentarista profissional.
Próxima Parada... 🚂
Módulo 3 - Diagramas e Visualização 🔌
Aula 09 - Mermaid na Prática 🧜♀️
Obrigado! 🙏
"Sua documentação é a voz do seu projeto quando você não está presente."