Pular para conteúdo

Aula 08 - Projeto Intermediário 🏗️

Objetivo

Objetivo: Consolidar todos os conhecimentos adquiridos nos Módulos 1 e 2 (Sintaxe Básica, Organização, Programação, Tabelas e GitHub) através da criação de uma documentação técnica completa para um pequeno sistema de software.

1. O Desafio do Projeto 🏆

Nesta aula prática, você não aprenderá comandos novos, mas sim como aplicar tudo o que vimos para criar um produto final profissional. Você deverá documentar um sistema fictício chamado "TaskMaster CLI" (ou um projeto de sua escolha).

O que deve ser documentado?

  1. README.md: Visão geral e badges.
  2. Guia de Instalação: Comandos de terminal e pré-requisitos.
  3. Referência Técnica: Tabelas de parâmetros e exemplos de código.
  4. Status do Projeto: Checklists de funcionalidades.

2. Checklist de Qualidade ✅

Antes de considerar sua documentação pronta, verifique se ela atende aos seguintes critérios: - [ ] Possui uma hierarquia de títulos clara. - [ ] Utiliza negrito e itálico para destacar termos importantes. - [ ] Contém pelo menos uma tabela técnica. - [ ] Apresenta blocos de código com destaque de sintaxe correto. - [ ] Utiliza links relativos para navegar entre os arquivos. - [ ] Possui pelo menos um diagrama Mermaid de fluxo.

3. Estrutura Recomendada (Mermaid) 🧜‍♀️

mermaid graph TD ROOT[README.md] --> DOCS[Pasta docs/] DOCS --> INTRO[intro.md] DOCS --> SETUP[setup.md] DOCS --> USAGE[uso.md] INTRO -->|Links| SETUP SETUP -->|Links| USAGE USAGE -->|Links| ROOT

4. Dicas de Ouro para sua Documentação 💡

  • Consistência: Use o mesmo estilo de títulos em todos os arquivos.
  • Escaneabilidade: Parágrafos curtos e muitas listas.
  • Visual: Use emojis para sinalizar seções de "Dica" ou "Aviso".
  • Badges: Utilize o Seals.io para mostrar que sua documentação está "100% Completa".

5. Simulação de Finalização de Versão 🐚

$ git add .
$ git commit -m "docs: finaliza projeto intermediário"
$ git tag -a v0.5 -m "Versão intermediária da documentação"
$ git push origin main --tags

6. Mini-Projeto: O Projeto Intermediário 🚀

Esta aula É o mini-projeto. Siga os requisitos detalhados na seção Projeto 08.

7. Exercícios de Reaproveitamento 🧠

  1. Revise seu arquivo aula-01.md. O que você mudaria nele usando o que aprendeu sobre Tabelas e Badges na Aula 06?
  2. Como a organização de arquivos em pastas (Aula 03) ajudou você a não se perder neste projeto intermediário?

Explicação: Na próxima aula, iniciaremos o Módulo 3 focando em Diagramas com Mermaid! 🧜‍♀️