docs-validator
验证文档质量
随着项目变化，文档可能变得不完整、不一致或过时。此技能会审计 Markdown 文档并返回按优先级排序的修复建议。
下载技能 ZIP
在 Claude 中上传
前往 Settings → Capabilities → Skills → Upload skill
开启并开始使用
Agent 可读资源
当 AI Agent、爬虫或脚本需要干净上下文，而不是读取完整页面时，请使用这些链接。
测试它
正在使用“docs-validator”。 发布前验证文档。
预期结果:
- 总体评分：良好，有两项高优先级修复和五项中优先级改进。
- 发布前应创建缺失的模块文档。
- 多个指南链接需要更新目标，并且有一条状态说明似乎已过时。
正在使用“docs-validator”。 检查文档中的损坏链接。
预期结果:
- 内部链接：大多数目标可解析，但有一个设置链接指向缺失页面。
- 外部链接：有一个下载链接返回错误，需要替换。
- 建议修复包括更正相对路径和更新外部目标。
正在使用“docs-validator”。 审查模块 README 覆盖率。
预期结果:
- 大多数模块都有 README 覆盖，但有一个大型模块缺少文档。
- 优先级应基于模块大小、用户影响和缺失示例来确定。
- 报告建议先创建缺失的 README，再完善较低优先级的格式问题。
安全审计
中风险Static analysis found many shell, network, filesystem, and weak-crypto patterns in SKILL.md. Manual review shows the weak-crypto, path traversal, reconnaissance, and hardcoded URL matches are false positives from prose or sample report text. The remaining risk is legitimate but elevated because the skill instructs agents to run shell documentation scans, inspect workspace files, optionally test external URLs, and write reports.
中风险问题 (2)
低风险问题 (4)
风险因素
⚙️ 外部命令 (7)
检测到的模式
质量评分
你能构建什么
准备发布文档
在发布前运行完整审计，以发现缺失的指南、过时的状态说明和损坏的引用。
改进贡献者入门体验
检查设置、贡献和故障排除内容是否完整且易于理解。
审查模块覆盖率
查找缺少 README 文件、示例、schema 引用或清晰使用说明的模块。
试试这些提示
验证此仓库中的文档。重点关注缺失文件、损坏的内部链接以及前三项修复。
检查文档链接。区分内部链接和外部链接，解释每个问题，并建议修正后的目标。
审计模块文档覆盖率。列出已有 README 文件的模块、缺少 README 文件的模块、示例薄弱的模块以及优先级顺序。
针对覆盖率、准确性、格式、链接、一致性、示例和发布就绪情况运行完整文档审计。
最佳实践
- 在日常编辑期间运行快速检查，并在发布前运行完整审计。
- 在允许自动化验证之前，审查 Shell 和网络操作。
- 将发现的问题转换为小型、按优先级排序且有负责人的文档任务。
避免
- 不要将示例评分或示例报告视为已验证的项目结果。
- 当仓库 URL 或浏览活动敏感时，不要运行外部链接检查。
- 不要在未检查具体证据的情况下接受大范围文档重写。