tomgoeck/project-docs-skill

O que project-docs-skill faz?

Skill para Claude Code: documentação de projeto em página única em project-docs/index.html, lida automaticamente e atualizada cirurgicamente pelo Claude.

Visão Geral

Este skill cria uma documentação de projeto de página única que o Claude lê automaticamente e atualiza apenas as partes relevantes quando o código muda.

Como Funciona

1. O Claude lê project-docs/index.html no início de cada conversa.
2. Se o arquivo não existir, o Claude cria a estrutura inicial com um resumo do projeto.
3. Quando código relevante é adicionado ou alterado, o Claude identifica as seções da documentação que precisam ser atualizadas e realiza edições cirúrgicas.
4. A documentação permanece focada e concisa, evitando duplicação de informações.

Comandos

• $ doc — Exibe ou cria a documentação do projeto em project-docs/index.html.
• $ doc update — Força uma atualização da documentação com base no estado atual do código.

Exemplo

# Iniciar documentação do projeto
$ doc

Requisitos

• Claude Code versão 2.0 ou superior.
• O arquivo project-docs/index.html deve estar em um diretório com permissão de leitura e escrita.

Notas

• A documentação é armazenada localmente, não enviada para servidores externos.
• O skill respeita arquivos ignorados pelo .gitignore.