Receber por email
← Voltar para o catálogo

doc-consistency-reviewer

Revisor de Consistência de Documentação. Esta skill verifica a consistência entre a implementação do código e a documentação, assegurando que READMEs, documentos e a documentação da API estejam precisos e atualizados.

2estrelas
Atualizado há 4 meses

Ver no GitHub ↗

Como adicionar

/plugin marketplace add bg-szy/TOP-SKILLS

O comando exato pode variar conforme o repositório. Confira o README no GitHub.

Para o autor da skill

Cole no README do seu repo

Mostra que sua skill está catalogada na Skillteca, gera backlink e tráfego rastreável.

[![Skillteca](https://www.skillteca.com.br/api/badge/doc-consistency-reviewer-bg-szy/svg)](https://www.skillteca.com.br/skills/doc-consistency-reviewer-bg-szy)

Alerta por categoria

Receba novas skills de Escrita e Conteúdo toda segunda

1 email curto, só com as skills novas de Escrita e Conteúdo. 4 minutos de leitura, sem spam, cancela com 1 clique.

Você confirma o email no primeiro envio. Sem spam. Cancela com 1 clique.

Ler descrição completa

Documentation Consistency Reviewer

目标

系统性找出 README + docs/ 中所有「过时」或「与实现不一致」的描述,输出 ≥30 条问题项。

核心原则

  1. 以代码为真 - 文档与代码冲突时,以源码/配置/合同文件为准
  2. 有证据再下结论 - 每条问题必须引用代码/配置位置作为依据
  3. 合同优先 - OpenAPI/proto/schema/TS types 视为 SSOT
  4. 安全默认收紧 - 安全相关不一致优先标记为高严重级别

审核流程

1. 文档枚举

# 扫描范围
- README.md (根目录)
- docs/**/*.md (所有文档)
- 合同文件: OpenAPI/proto/GraphQL schema/TS types

2. 逐文档审阅

对每份文档:

  1. 列出关键声明/承诺/配置/接口条目
  2. 在代码中搜索对应实现
  3. 对比差异:缺失/重命名/行为不一致/默认值不一致
  4. 按模板记录问题项

[Description truncada. Veja o README completo no GitHub.]

Compartilhar X LinkedIn