---
name: docs-2132a9d91207
description: >-
  Atualiza documentação do projeto incluindo README, IMPLEMENTATION e CHANGELOG. Use quando precisar gerar ou atualizar documentação técnica, changelogs, ou documentação de API.
compatibility: Qualquer projeto
metadata:
  author: aronpc
  version: 5.0.0
  category: quality
allowed-tools:
  - Read
  - Write
  - Edit
  - Bash
---

# docs

## Resumo
Atualiza documentação do projeto (README, IMPLEMENTATION, CHANGELOG, API docs).

## Skills Relacionadas

| Skill | Quando usar junto |
|-------|-------------------|
| `sprint` | Para documentar progresso do sprint |
| `coder` | Para atualizar docs pós-implementação |
| `cicd` | Para atualizar docs pós-deploy |
| `spec` | Para criar specs a partir de docs |

## Quando usar

Use esta skill sempre que:
- Implementar qualquer feature/tarefa
- Completar marcos principais
- Atualizar progresso do projeto
- Preparar para versão/releases

## CRÍTICO: Atualizações de Documentação

**OBRIGATÓRIO:** Após implementar QUALQUER feature, atualize docs nesta ordem:

### 1. IMPLEMENTATION.md (SEMPRE)

**Quando:** Após completar QUALQUER tarefa, feature ou sub-feature

**O que:**

- Marque itens completados: `[ ]` → `[x]`
- Atualize percentagem de progresso
- Atualize campo "Status" em seções
- Atualize tabela "Progresso Geral"
- Atualize linha "Total:" de progresso
- Atualize "Próximos Passos"

**Exemplo:**

```markdown
### 6.4 Staff Management ✅

- [x] Backend completo ✅
    - `StaffController` com CRUD completo (index, create, store, edit, update, destroy)

**Status:** Staff Management 100% completo - Backend, Forms, todas as páginas implementados.
```

### 2. CHECKPOINT.md (Marcos Principais Apenas)

**Quando:** Após feature principal, marco de versão, ou fim de sessão de trabalho

**O que:**

- **Última Atualização:** Data/hora atual
- **Versão Atual:** Bump version (v1.8.0 → v1.9.0)
- **Progresso Total:** Atualize percentagem
- **Onde Paramos:** Atualize seção "✅ Completo"
- **Próximos Passos:** Atualize o que vem a seguir
- **Métricas do Projeto:** Atualize contadores

### 3. README.md (Apenas Quando Necessário)

**Quando:** APENAS para mudanças significativas em:

- Visão geral do projeto
- Passos de instalação
- Features principais que mudam proposta de valor
- Mudanças no tech stack
- Novos comandos/padrões de uso

### Workflow de Documentação

```bash
# Após implementar uma feature:

# 1. SEMPRE atualize IMPLEMENTATION.md
# Marque tarefas completadas, atualize percentagens

# 2. Se marco principal, atualize CHECKPOINT.md
# Atualize versão, progresso, métricas

# 3. Se mudança significativa, atualize README.md (opcional)
# Apenas se visão geral do projeto mudou

# 4. Commit documentação separadamente
git add IMPLEMENTATION.md CHECKPOINT.md
git commit -m "docs: Update implementation progress to v1.9.0 (58.5%)"
```

## Regras de Resumo

| Arquivo | Quando | Frequência |
|---------|---------|------------|
| **IMPLEMENTATION.md** | Após cada feature/tarefa | ✅ SEMPRE |
| **CHECKPOINT.md** | Após features principais ou sessões | ⚠️ FREQUENTEMENTE |
| **README.md** | Apenas mudanças de visão geral | ℹ️ RARAMENTE |

## O Que NÃO Fazer

- ❌ Pular atualização de IMPLEMENTATION.md
- ❌ Atualizar README.md para cada pequena mudança
- ❌ Esquecer de atualizar percentagens e campos de status
- ❌ Commitar código e documentação juntos
- ❌ Deixar CHECKPOINT.md desatualizado após marco principal

## Formato de IMPLEMENTATION.md

### Estrutura de Seção

```markdown
### X.X Nome da Feature 🚧

**Descrição:** Breve descrição da feature

**Status:** Em andamento | Planejado | Concluído ✅

- [ ] Subtarefa 1
- [ ] Subtarefa 2
- [ ] Subtarefa 3

**Progresso:** XX%

**Próximos Passos:**
- [ ] Próximo passo 1
- [ ] Próximo passo 2
```

## Formato de CHECKPOINT.md

```markdown
# Checkpoint - v1.X.0

**Última Atualização:** AAAA-MM-DD HH:MM

**Versão Atual:** v1.X.0

**Progresso Total:** XX%

---

## ✅ Completo

### Features Implementadas

- Feature 1
- Feature 2

### Métricas do Projeto

- Total de Features: XX
- Features Concluídas: XX
- Progresso: XX%

---

## Próximos Passos

- [ ] Próxima feature 1
- [ ] Próxima feature 2
```

## Comandos Úteis

```bash
# Commitar apenas documentação
git add IMPLEMENTATION.md CHECKPOINT.md
git commit -m "docs: Update implementation progress"

# Ver mudanças desde último commit
git diff HEAD~1 IMPLEMENTATION.md
```

## Exemplos de Commits de Documentação

```bash
# ✅ GOOD - Atualização de progresso
git commit -m "docs: Update implementation progress - Staff Management complete (100%)"

# ✅ GOOD - Marco de versão
git commit -m "docs: Update checkpoint to v1.9.0 - 58.5% complete"

# ✅ GOOD - Mudança significativa
git commit -m "docs: Update README - Add Laravel Boost integration section"
```

## Melhores Práticas

### ✅ FAÇA

- Sempre atualize IMPLEMENTATION.md após cada tarefa
- Use marcadores claros de status (🚧, ✅, ❌)
- Mantenha percentagens atualizadas
- Atualize CHECKPOINT.md após marcos principais
- Commit documentação separadamente do código
- Use mensagens descritivas em commits

### ❌ NÃO FAÇA

- Não pule atualização de IMPLEMENTATION.md
- Não atualize README.md para cada pequena mudança
- Não esqueça de atualizar campos de status
- Não misture código e documentação no mesmo commit
- Não use mensagens vagas de commit

## Checklist de Documentação

Antes de finalizar qualquer feature:

- [ ] IMPLEMENTATION.md atualizado
- [ ] Tarefas marcadas como completas
- [ ] Percentagem de progresso atualizada
- [ ] Status atualizado
- [ ] Próximos passos definidos
- [ ] CHECKPOINT.md atualizado (se aplicável)
- [ ] README.md atualizado (se necessário)
- [ ] Documentação commitada separadamente

## Workflow Git

**Integração com workflow:**

Documentação deve ser commitada separadamente do código, seguindo Conventional Commits:

```bash
# Workflow completo após implementar feature:
# 1. Commit de código
git add app/ resources/
git commit -m "feat: Add Staff Management CRUD"

# 2. Commit de documentação
git add IMPLEMENTATION.md CHECKPOINT.md
git commit -m "docs: Update implementation progress - Staff Management complete"
```

Veja `workflow` para:
- Formato de mensagens Conventional Commits
- Regras de commits atômicos
- Commits de documentação com prefixo `docs:`
- Tracking de features em sprints (veja `sprint`)

## Referências

- [Laravel Documentation](https://laravel.com/docs) - Documentação oficial


---
Source attribution: aronpc
Original project: https://github.com/aronpc/ai/blob/85e01f1cbbd8159dd87c408f226435c0b3201c09/skills/docs/SKILL.md
License: MIT
License information: https://opensource.org/license/mit
Original upstream instructions; downloaded from Mega AI Hub.

## Upstream license notice

MIT License

Copyright (c) 2026 AronPC

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.



# Mega AI Hub resource metadata

Creator / publisher: aronpc
Original project: https://github.com/aronpc/ai/blob/85e01f1cbbd8159dd87c408f226435c0b3201c09/skills/docs/SKILL.md
Attribution basis: Source repository record

Fields of work: Project & Program Management, Content & Media, Development & Engineering
Roles: Project Manager, Technical Writer, Backend Developer
Specialties: Word Documents, Git
Tools: Tool not specified
Country applicability: Country not specified
Classification basis: Source category, role and specialization labels
Instruction SHA-256: cd9c453c908a8bb3727c4694033fda1b55b4b18a77e5043bfa14a1411a9c4c7d