O que update-oo-component-documentation faz?
Atualiza a documentação existente de componentes orientados a objetos seguindo as melhores práticas do setor e padrões de documentação arquitetural.
Visão Geral
Esta skill automatiza a atualização da documentação de componentes OO (orientados a objetos), analisando o código-fonte e gerando documentação atualizada que reflete a estrutura e o comportamento reais dos componentes.
Funcionalidades
- Análise de classes, interfaces, métodos e atributos
- Geração de diagramas de classe em formato texto (Mermaid ou PlantUML)
- Documentação de padrões de design aplicados
- Atualização de links e referências cruzadas
- Suporte a múltiplos formatos de saída (Markdown, HTML, PDF)
Como Usar
- Execute o comando
update-docsno diretório do projeto - A skill irá escanear o código-fonte em busca de componentes OO
- A documentação será gerada ou atualizada no diretório
docs/
Configuração
Crie um arquivo .oo-docs-config.json na raiz do projeto:
{
"sourceDir": "src",
"outputDir": "docs",
"format": "markdown",
"includeDiagrams": true
}
Compatibilidade
- Linguagens: Java, C#, Python, TypeScript, PHP
- Plataformas: GitHub Actions, GitLab CI, CLI local
Exemplo
npx update-oo-docs --input src --output docs --format markdown
Contribuição
Veja CONTRIBUTING.md para detalhes sobre como contribuir.