Documentação - Wiki do repositório

[henriqueotogami]

Criar página de documentação por capítulo

Objetivo

Desenvolver uma página de documentação estruturada para cada capítulo/módulo de conteúdo estudado para a certificação Java OCA, facilitando a revisão e consolidação do aprendizado, com rastreamento completo de issues e PRs relacionadas.

Descrição

Cada página deve documentar o conteúdo teórico, exemplos práticos, conceitos-chave e pontos importantes de cada capítulo estudado no roadmap de Java OCA. A página deve servir como hub central para todas as atividades (issues, PRs, tasks) relacionadas àquele capítulo.

Hierarquia de Capítulos

chapter-done/ 
|------ chapter01 
|------ chapter02 
|------ chapter03 
|------ chapter04 
|------ chapter05 
|------ chapter06 
|------ chapter07

Estrutura proposta para cada página

1. Cabeçalho

• Número e nome do capítulo
• Data de criação/atualização
• Nível de dificuldade
• Status de conclusão

2. Resumo executivo

• Visão geral dos tópicos cobertos
• Objetivos de aprendizado
• Relação com capítulos anteriores/posteriores

3. Conceitos principais

• Definições claras
• Terminologia importante
• Relações entre conceitos

4. Exemplos práticos

• Código de exemplo comentado
• Casos de uso reais
• Anti-patterns a evitar
• Referência ao diretório oca/chapterXX/ no código

5. Pontos críticos para OCA

• Tópicos que frequentemente caem em provas
• Pegadinhas e armadilhas comuns
• Dicas de memorização

6. Exercícios e quiz

• Perguntas práticas
• Links para problemas relacionados
• Referência aos testes em src/test/java

7. Rastreamento de Atividades (NOVO)

7.1 Issues Relacionadas

• Lista de todas as issues associadas a este capítulo
• Formato: #numero-da-issue - Título descritivo
• Marcadas com label chapter-XX

7.2 Pull Requests Relacionadas

• Lista de todas as PRs merged e em revisão
• Formato: #numero-pr - Título descritivo [STATUS]
• Referência às issues que fecharam

7.3 Tasks Gradle

• Comando: ./gradlew chapterXX (ex: ./gradlew chapter01)
• Como executar testes isolados do capítulo
• Resultados esperados

7.4 Tags Git

• Tag de release: chapter-XX (ex: chapter-01)
• Tag de task: task-XX-descricao (ex: task-01-variaveis)

8. Referências

• Links para documentação oficial
• Recursos adicionais
• Capítulos relacionados (anterior/próximo)

Exemplo de Estrutura - Seção de Rastreamento (Seção 7)

## 🔗 Rastreamento de Atividades - Chapter 01

### 📋 Issues Relacionadas
- [#12 - Adicionar exemplos de empacotamento](https://github.com/henriqueotogami/road-to-java-oca/issues/12)
- [#15 - Criar exercícios de imports](https://github.com/henriqueotogami/road-to-java-oca/issues/15)

### ✅ Pull Requests
- [#18 - Implementar exemplos chapter01 (MERGED)](https://github.com/henriqueotogami/road-to-java-oca/pull/18)
- [#22 - Testes chapter01 com JUnit 5 (MERGED)](https://github.com/henriqueotogami/road-to-java-oca/pull/22)

### ⚙️ Gradle
- Task: `./gradlew chapter01` — executa todos os testes do capítulo
- Resultado esperado: todos os testes devem passar ✅

### 🏷️ Git Tags
- Release: `chapter-01` — marca conclusão do capítulo
- Tasks: `task-01-empacotamento`, `task-01-imports`, `task-01-compilacao`

## Critérios de aceitação

- [ ]  Página criada em chapter-done/chapterXX.md (ex: chapter-done/chapter01.md)
- [ ]  Estrutura markdown consistente com outros capítulos
- [ ]  Mínimo de 3 exemplos de código práticos
- [ ]  Seção de pontos críticos para OCA preenchida
- [ ]  Todas as issues do capítulo listadas e linkadas
- [ ]  Todas as PRs do capítulo listadas e linkadas com status
- [ ]  Task Gradle do capítulo documentada
- [ ]  Tags git do capítulo referenciadas
- [ ]  Links internos para capítulos anteriores/próximos funcionando
- [ ]  Links para o código-fonte em src/main/java/oca/chapterXX/ funcionando
- [ ]  Linguagem clara e acessível

### Benefícios

- Centraliza conhecimento por tema
- Facilita revisão rápida antes de provas
- Cria material de referência permanente
- Melhora rastreabilidade: todas as atividades vinculadas a um capítulo em um só lugar
- Histórico completo de desenvolvimento visível
- Facilita onboarding de novos colaboradores

### Labels sugeridos

- documentation
- java-oca
- content
- chapter-XX (ex: chapter-01, chapter-02)

--------

Prioridade: Média
Tipo: Enhancement
Dependência: Requer conclusão do capítulo (ou parcial, se em desenvolvimento)

[henriqueotogami]

Atualização da wiki do projeto

Atualizei a wiki do repositório com a estrutura base para a documentação por capítulo do roadmap Java OCA.

O que foi incluído

• Organização por capítulo: chapter-done/chapterXX
• Cabeçalho com dados do capítulo
• Resumo executivo e objetivos de aprendizagem
• Conceitos principais e terminologia relevante
• Exemplos práticos com referência ao código do projeto
• Pontos críticos para a certificação OCA
• Exercícios, quizzes e links para testes
• Rastreamento de atividades:
  • issues relacionadas
  • pull requests relacionadas
  • tasks Gradle
  • tags Git
• Referências e links para capítulos relacionados

Objetivo da atualização

A wiki agora funciona como um hub central de conhecimento para cada capítulo, facilitando:

• revisão rápida dos conteúdos estudados
• rastreabilidade das atividades do projeto
• organização das issues/PRs por módulo
• acompanhamento do progresso por capítulo
• onboarding de novos participantes no roadmap

Estrutura prevista

A documentação foi organizada para manter um padrão consistente entre os capítulos, com foco em:

• teoria
• prática
• revisão
• acompanhamento de atividades e histórico do desenvolvimento

Próximo passo

Continuar preenchendo a wiki capítulo a capítulo, alinhando cada página com os exemplos, testes e atividades vinculadas ao conteúdo estudado.

Link da wiki: https://github.com/henriqueotogami/road-to-java-oca/wiki