Installs: 0
Used in: 2 repos
Updated: 2d ago
$
npx ai-builder add command Just-mpm/docInstalls to .claude/commands/doc.md
# 📚 Atualização Inteligente de Documentação Você foi solicitado a **atualizar toda a documentação do projeto** para refletir o estado atual do código. **Descrição da mudança:** $ARGUMENTS --- ## 🔍 FASE 1: DESCOBERTA AUTOMÁTICA ### 1️⃣ **Mapear Arquivos de Documentação Existentes** Use `Glob` para encontrar TODOS os arquivos de documentação no projeto: ```bash # Documentação principal (root) README.md CLAUDE.md CHANGELOG.md CONTRIBUTING.md # Pastas de documentação docs/**/*.md .github/**/*.md ``` **Categorize os arquivos encontrados:** - 📖 **Guias principais:** README.md, CLAUDE.md - 📝 **Histórico:** CHANGELOG.md - 🏗️ **Arquitetura:** docs/architecture/ (overview, folder-structure, code-patterns, state-management, routing) - 🧩 **Componentes:** docs/components/ (design-system, base-components, form-components, layout-components, feedback-components) - 🔥 **Firebase:** docs/firebase/ (setup, authentication, firestore, storage, cloud-functions, ai-logic, security-rules) - 📡 **APIs:** docs/api/ (integrações externas, endpoints) - 🚀 **Guias:** docs/guides/ (setup, local-development, deployment, testing, troubleshooting, faq) ### 2️⃣ **Identificar Mudanças Recentes Não Documentadas** Use `Bash` para analisar commits/mudanças recentes: ```bash # Arquivos modificados recentemente (últimos 7 dias) git log --since="7 days ago" --name-only --pretty=format: | sort -u # Arquivos criados recentemente git log --since="7 days ago" --diff-filter=A --name-only --pretty=format: | sort -u # Commits recentes (contexto) git log --since="7 days ago" --oneline --decorate ``` **Compare com documentação (foco Next.js + React + TypeScript + MUI V7 + Firebase):** - ✅ Novos componentes em `components/` sem documentação? - ✅ Novas páginas/rotas em `app/` não documentadas? - ✅ Novos hooks customizados em `hooks/` não catalogados? - ✅ Mudanças em Firebase (queries, rules, indexes)? - ✅ Mudanças em tema MUI V7 (`lib/theme/`)? - ✅ Novos types/interfaces em `types/`? ### 3️⃣ **Verificar Stack do Projeto (Next.js + React + TypeScript + MUI V7 + Firebase)** Use `Read` para confirmar versões e configurações: ```bash # Verificar versões da stack package.json → Next.js, React, MUI, Firebase, TypeScript # Configurações críticas next.config.js/ts → Config Next.js tsconfig.json → TypeScript strict mode firebase.json → Firebase config lib/theme/ → Tema MUI V7 ``` --- ## 📋 FASE 2: PLANEJAMENTO DE ATUALIZAÇÃO ### 🎯 **Estratégia de Atualização (Ordem de Prioridade)** 1. **CHANGELOG.md** (SEMPRE atualizar) - Adicionar nova entrada com mudanças recentes - Formato: Added/Fixed/Changed/Technical Details/Validation - Incluir data (YYYY-MM-DD) 2. **README.md** (Atualizar se houver) - Novas features/seções importantes - Mudanças em setup/instalação - Atualizar badges (versões, build status) 3. **CLAUDE.md** (Atualizar se CRÍTICO) - Mudanças em padrões CRÍTICOS (Next.js, MUI V7, Firebase, TypeScript) - Novas rotas/páginas principais - Mudanças no tech stack ou configurações essenciais - ⚠️ **MANTER ENXUTO!** Máx 300-500 linhas **NÃO adicionar em CLAUDE.md:** - ❌ Novos componentes (vai em `docs/components/`) - ❌ Padrões técnicos avançados (vai em `docs/architecture/code-patterns.md`) - ❌ Firebase schemas/patterns (vai em `docs/firebase/firestore.md`) - ❌ Histórico de mudanças (vai em `CHANGELOG.md`) 4. **Documentação Técnica Especializada** (Atualizar se aplicável) - **docs/components/base-components.md** → Novos componentes reutilizáveis em `components/common/` - **docs/architecture/code-patterns.md** → Novos padrões TS/React/MUI V7/Firebase - **docs/firebase/firestore.md** → Novos schemas, queries, security rules - **docs/firebase/storage.md** → Mudanças em upload/storage - **docs/guides/troubleshooting.md** → Problemas comuns encontrados e soluções 5. **PROJECT-STATUS.md** (Atualizar se existir) - Data de "Última atualização" - Marcar TODOs concluídos [x] - Atualizar progresso visual (%) - Adicionar novas páginas/componentes nas tabelas --- ## ✅ FASE 3: EXECUÇÃO (CHECKLIST) ### 📝 **1. CHANGELOG.md** **SEMPRE adicionar nova entrada no topo:** **Formato obrigatório:** ```markdown ## [0.X.0] - YYYY-MM-DD ### 🎨 Sessão X: [Título Descritivo] #### Added - Lista de novos componentes, páginas, features - Seja específico: nomes de arquivos (`ComponenteX.tsx`), funcionalidades #### Fixed - Bugs corrigidos com descrição clara #### Changed - Modificações em código existente #### Technical Details - Stack: Next.js [versão], React [versão], MUI V7, Firebase, TypeScript - Padrões: Mobile-first, dark mode (se aplicável), acessibilidade WCAG AA - Responsividade: [Breakpoints testados] - Performance: [Otimizações, se houver] #### Validation - ✅ `npm run lint` - 0 errors, 0 warnings - ✅ `npm run build` - Build com sucesso - ✅ Responsividade testada (375px, 768px, 1200px) ``` **Descrição da mudança:** $ARGUMENTS ### 📖 **2. README.md** **Atualizar APENAS se:** - ✅ Novas features/seções importantes - ✅ Mudanças em instalação/setup - ✅ Atualização de badges (versões Next.js, React, etc.) **NÃO atualizar se:** - ❌ Mudanças internas sem impacto externo - ❌ Detalhes técnicos (vão em `docs/`) ### 🧠 **3. CLAUDE.md** **Atualizar APENAS se CRÍTICO:** - ✅ Mudança em stack principal (ex: Next.js 15→16, MUI V6→V7) - ✅ Novas rotas/páginas principais (ex: nova seção do app) - ✅ Novos padrões de arquitetura obrigatórios - ✅ Configurações essenciais (Firebase, MUI theme, TypeScript) **NÃO adicionar em CLAUDE.md:** - ❌ Novos componentes → vai em `docs/components/base-components.md` - ❌ Padrões técnicos avançados → vai em `docs/architecture/code-patterns.md` - ❌ Firebase schemas/patterns → vai em `docs/firebase/firestore.md` - ❌ Histórico de mudanças → vai em `CHANGELOG.md` - ❌ Status de progresso → vai em `PROJECT-STATUS.md` **CLAUDE.md deve permanecer enxuto (Máx 300-500 linhas)!** ### 🏗️ **4. Documentação Técnica Especializada** **Atualizar APENAS se houver mudanças relevantes:** **docs/components/base-components.md** - ✅ Adicionar novos componentes reutilizáveis criados em `components/common/` - ✅ Atualizar props ou exemplos de uso de componentes existentes - ✅ Incluir código completo e padrões de uso **docs/architecture/code-patterns.md** - ✅ Adicionar novos padrões técnicos avançados (TypeScript, React, MUI V7, Firebase, Next.js) - ✅ Documentar novas práticas de acessibilidade ou responsividade - ✅ Atualizar exemplos de código se padrões mudaram **docs/firebase/firestore.md** - ✅ Adicionar novos padrões de integração Firestore - ✅ Documentar novas collections ou schemas - ✅ Atualizar security rules ou queries se mudaram **docs/firebase/storage.md** - ✅ Mudanças em upload de arquivos/imagens - ✅ Novas validações ou regras de storage **docs/guides/troubleshooting.md** - ✅ Problemas comuns encontrados durante desenvolvimento - ✅ Soluções para erros de build, Firebase, MUI, etc. **Quando NÃO atualizar:** Se a mudança foi apenas uma implementação pontual de feature usando padrões existentes. ### 📊 **5. PROJECT-STATUS.md** (se existir) Atualize para refletir o SNAPSHOT atual: - ✅ Atualizar data de "Última atualização" - ✅ Adicionar novas páginas na tabela "Páginas" - ✅ Adicionar novos componentes nas tabelas de componentes - ✅ Marcar checkboxes [x] para TODOs concluídos - ✅ Atualizar "Progresso Visual" (porcentagens) - ✅ Atualizar "Meta Atual" se mudou o foco **NÃO mudar:** - ❌ Versão (manter até lançamento oficial) - ❌ Estrutura de pastas (só se mudou de verdade) - ❌ Decisões técnicas (seção permanente) --- ## 🔍 FASE 4: VALIDAÇÃO FINAL ### ✅ **Checklist de Qualidade** 1. **Consistência entre documentos:** - [ ] CLAUDE.md mantém ~300-500 linhas com apenas contexto essencial? - [ ] CHANGELOG.md documenta as mudanças desta sessão? - [ ] PROJECT-STATUS.md reflete o estado atual (checkboxes, progresso)? - [ ] Documentação técnica (docs/components/, docs/architecture/, docs/firebase/) está atualizada se relevante? 2. **Verificar separação correta:** - [ ] Contexto essencial e crítico → CLAUDE.md (enxuto) - [ ] Catálogo de componentes completo → docs/components/base-components.md - [ ] Padrões técnicos avançados → docs/architecture/code-patterns.md - [ ] Firebase patterns → docs/firebase/firestore.md - [ ] Histórico de mudanças → CHANGELOG.md - [ ] Estado atual e progresso → PROJECT-STATUS.md 3. **Formatação e links:** - [ ] Markdown correto (listas, código, tabelas) - [ ] Emojis consistentes - [ ] Links internos funcionando (ex: CLAUDE.md → docs/components/) - [ ] Blocos de código com syntax highlighting correto (tsx, ts, json, bash) 4. **Completude (Next.js + React + TypeScript + MUI V7 + Firebase):** - [ ] Novos componentes documentados com props e exemplos? - [ ] Novas páginas/rotas explicadas (SSG/SSR/CSR)? - [ ] Mudanças em Firebase (queries, rules, indexes) refletidas? - [ ] Padrões MUI V7 documentados (mobile-first, theme.vars)? - [ ] TypeScript types/interfaces catalogados? --- ## 📝 RELATÓRIO FINAL Após concluir, forneça um resumo: ```markdown ## ✅ Documentação Atualizada ### Arquivos Modificados - `CHANGELOG.md` - Nova entrada: [Versão 0.X.0] - [Sessão X: Título] - `README.md` - Seções atualizadas: [Lista ou "Nenhuma mudança"] - `CLAUDE.md` - Mudanças críticas: [Lista ou "Nenhuma mudança"] - `docs/components/base-components.md` - Novos componentes: [Lista ou "Nenhuma mudança"] - `docs/architecture/code-patterns.md` - Novos padrões: [Lista ou "Nenhuma mudança"] - `docs/firebase/firestore.md` - Schemas/queries: [Lista ou "Nenhuma mudança"] - `PROJECT-STATUS.md` - Status atualizado: [Progresso %] ### Principais Mudanças Documentadas #### Added - [Lista de novos componentes, páginas, features] #### Fixed - [Lista de bugs corrigidos] #### Changed - [Lista de modificações] #### Technical Details - Stack: Next.js [versão], React [versão], MUI V7, Firebase, TypeScript - Padrões: Mobile-first, dark mode (se aplicável), WCAG AA - Validação: lint ✅, build ✅, responsividade ✅ ### Arquivos de Documentação no Projeto - [Lista de todos os .md encontrados] ### Recomendações - [Sugestões de melhorias futuras, documentação faltante, etc.] ``` --- ## 💡 DICAS PRO 1. **Use TodoWrite** para planejar as atualizações ANTES de executar 2. **Leia documentação existente** para seguir padrão e formato do projeto 3. **Seja conservador** - melhor documentar menos com qualidade do que muito com ruído 4. **CLAUDE.md ENXUTO** - Máx 300-500 linhas, apenas contexto crítico 5. **Detalhes técnicos vão em docs/** - Componentes, padrões, Firebase, troubleshooting 6. **CHANGELOG SEMPRE** - Histórico de mudanças é OBRIGATÓRIO
Quick Install
$
npx ai-builder add command Just-mpm/docDetails
- Type
- command
- Author
- Just-mpm
- Slug
- Just-mpm/doc
- Created
- 6d ago