skills/hylarucoder/doc-consistency-reviewer/SKILL.md
文档一致性审核官,检查代码实现与文档说明的一致性。当用户请求审查文档与代码的一致性、检查 README/docs 是否过时、验证 API 文档准确性时使用此技能。适用于:(1) 审查 README 与实现一致性 (2) 检查 docs/ 目录文档是否过时 (3) 验证 API/配置文档准确性 (4) 生成文档一致性报告。触发词包括:文档审查、doc review、文档一致性、documentation consistency、检查文档过时、verify docs。
npx skillsauth add aiskillstore/marketplace doc-consistency-reviewerInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
系统性找出 README + docs/ 中所有「过时」或「与实现不一致」的描述,输出 ≥30 条问题项。
# 扫描范围
- README.md (根目录)
- docs/**/*.md (所有文档)
- 合同文件: OpenAPI/proto/GraphQL schema/TS types
对每份文档:
详细检查清单见 references/checklist.md
| 级别 | 定义 | 示例 | |------|------|------| | P0 | 安全问题/严重误导 | 文档称已启用沙箱但代码未启用 | | P1 | 核心功能不一致 | 按文档操作会失败 | | P2 | 示例不完整/命名不一致 | 不直接阻断使用 | | P3 | 措辞/格式/链接小问题 | 不影响功能 | | 待证据补充 | 有怀疑但证据不足 | 需进一步调查 |
详细模板见 references/output-format.md
### [标题]
- **严重级别**: P0/P1/P2/P3/待证据补充
- **位置**: `<文件路径>:<行号>`
- **证据**:
- 文档: [引用]
- 代码: [引用]
- **影响**: [误导后果]
- **建议**: [最小修正]
- **关联原则**: 以代码为真/合同优先/安全默认收紧/...
## 审核结论
- **结论**: 通过/有条件通过/不通过
- **汇总**: P0:x P1:x P2:x P3:x 待补充:x
- **修复优先级**: P0 → P1 → P2 → P3
如需加速,可按以下维度拆分给多个 agent 并行执行:
汇总时需去重和统一严重级别。
审阅完成后,输出 doc-consistency.md 报告文件。
development
Apple Human Interface Guidelines for content display components. Use this skill when the user asks about charts component, collection view, image view, web view, color well, image well, activity view, lockup, data visualization, content display, displaying images, rendering web content, color pickers, or presenting collections of items in Apple apps. Also use when the user says how should I display charts, what's the best way to show images, should I use a web view, how do I build a grid of items, what component shows media, or how do I present a share sheet. Cross-references: hig-foundations for color/typography/accessibility, hig-patterns for data visualization patterns, hig-components-layout for structural containers, hig-platforms for platform-specific component behavior.
tools
Automate HelpDesk tasks via Rube MCP (Composio): list tickets, manage views, use canned responses, and configure custom fields. Always search tools first for current schemas.
testing
Expert Haskell engineer specializing in advanced type systems, pure functional design, and high-reliability software. Use PROACTIVELY for type-level programming, concurrency, and architecture guidance.
tools
GraphQL gives clients exactly the data they need - no more, no less. One endpoint, typed schema, introspection. But the flexibility that makes it powerful also makes it dangerous. Without proper controls, clients can craft queries that bring down your server. This skill covers schema design, resolvers, DataLoader for N+1 prevention, federation for microservices, and client integration with Apollo/urql. Key insight: GraphQL is a contract. The schema is the API documentation. Design it carefully.