documentation-audit
Verificar precisão da documentação em relação ao código
也可从以下获取: 2389-research
Documentação desatualizada causa confusão e bugs quando o código muda mas a documentação não é atualizada. Esta skill verifica sistematicamente as afirmações na documentação markdown em relação ao código real usando uma abordagem de duas etapas com expansão de padrões para detectar problemas similares.
下载技能 ZIP
在 Claude 中上传
前往 设置 → 功能 → 技能 → 上传技能
开启并开始使用
测试它
正在使用“documentation-audit”。 Audite os arquivos de documentação em docs/ para verificar precisão
预期结果:
- Relatório de Auditoria de Documentação - Gerado em: 2026-01-10
- Resumo Executivo: 12 documentos escaneados, ~180 afirmações verificadas
- Verificado VERDADEIRO: 145 afirmações (81%)
- Verificado FALSO: 31 afirmações (17%) requerendo correções
- Afirmação Falsa - CONFIGURATION.md:135 - 'claude-sonnet-4-5' deveria ser 'claude-3-5-sonnet-latest'
- Padrão Encontrado: 9 referências de scripts mortos em 4 arquivos
- Fila de Revisão Humana: 4 afirmações comportamentais precisam de verificação
正在使用“documentation-audit”。 Verifique nossa documentação após renomear serviços de ai-radio-* para radio-*
预期结果:
- Encontradas 5 referências de serviços desatualizadas: ai-radio-break-gen.service (agora generate-break.service)
- Encontradas 3 referências de timer obsoletas usando convenção de nomenclatura antiga
- Busca de Padrões: Identificados 4 documentos adicionais com inconsistências de nomenclatura similares
- Todas as referências atualizadas em AUDIT_REPORT_2026-01-16.md com evidências arquivo:linha
安全审计
安全All 116 static findings are false positives. The static analyzer incorrectly flagged markdown documentation as executable code. All flagged items are documentation examples showing verification patterns, not actual security vulnerabilities. Previous audit explicitly confirmed: no malicious patterns detected.
风险因素
📁 文件系统访问 (3)
质量评分
你能构建什么
Verificação pré-lançamento
Verificar se toda a documentação está precisa antes de fazer deploy ou lançar releases
Verificações pós-refatoração
Detectar documentação desatualizada após refatoração ou renomeação de arquivos e serviços
Auditorias de documentação
Escanear sistematicamente a documentação para referências desatualizadas e afirmações obsoletas
试试这些提示
Audite estes arquivos de documentação para verificar precisão: [lista de arquivos]
Execute uma auditoria completa da documentação deste projeto. Foque apenas em documentos voltados ao usuário.
Verifique se a documentação corresponde à realidade após nossa refatoração recente. Procure por referências de scripts mortos, serviços renomeados e padrões de configuração desatualizados.
Encontrei uma referência de script morto. Pesquise toda a documentação por padrões similares e verifique cada um.
最佳实践
- Use agentes paralelos para extração para maximizar eficiência em múltiplos documentos
- Sempre execute a expansão de padrões da Etapa 2 - ela detecta 10-20% mais problemas do que apenas a Etapa 1
- Registre evidências (arquivo:linha) para cada veredicto para apoiar correções sugeridas com provas
避免
- Pular a expansão de padrões da Etapa 2 reduz significativamente a cobertura de detecção de problemas
- Confiar que a documentação 'parece correta' sem verificação permite que documentação desatualizada persista
- Auditar documentos de design ou planos em vez de documentação voltada ao usuário desperdiça esforço de auditoria
常见问题
Que tipos de afirmações esta skill pode verificar automaticamente?
Esta skill modifica meus arquivos de documentação?
O que é a expansão de padrões da Etapa 2?
Quanto tempo leva uma auditoria completa?
Posso integrar isso em pipelines CI/CD?
Como isso é diferente de linters ou análise estática?
开发者详情
许可证
MIT
引用
main
文件结构