技能 docs-validator
📚

docs-validator

安全 🌐 網路存取📁 檔案系統存取⚙️ 外部命令

验证文档质量

文档质量问题会浪费开发者的时间并让用户感到沮丧。此技能会扫描您的文档，检查完整性、损坏的链接、格式错误和一致性问题，然后提供可操作的修复建议和优先级排序的建议。

支援: Claude Codex Code(CC)
📊 70 充足
1

下載技能 ZIP

2

在 Claude 中上傳

前往 設定 → 功能 → 技能 → 上傳技能

3

開啟並開始使用

測試它

正在使用「docs-validator」。 Validate the documentation

預期結果:

  • Documentation Validation Report
  • Overall Score: 82/100 (Good)
  • Coverage: 91% module READMEs, 80% user guides
  • Critical Issues: 2 (missing misc module docs, broken external link)
  • Top Priority: Create source/misc/README.md to document 82 classes

正在使用「docs-validator」。 Check for broken links

預期結果:

  • Found 3 broken links:
  • 1. docs/README.md:15 - [Setup](setup.md) - File not found
  • 2. docs/user-guide/installation.md:45 - https://old-url.com/download - 404 Not Found
  • 3. docs/api/reference.md:72 - [Auth](../auth/reference.md) - Section anchor invalid

正在使用「docs-validator」。 Analyze module documentation coverage

預期結果:

  • Module READMEs: 10/11 (91%)
  • Missing: source/misc/README.md (82 classes undocumented)
  • All other modules have complete documentation
  • Recommended: Create misc/README.md to document 61% of undocumented classes

安全審計

安全
v5 • 1/16/2026

This is a pure prompt-based skill with no executable code. The SKILL.md file contains only documentation validation guidelines and example prompts for an AI assistant. All 65 static findings are false positives: cryptographic algorithm detections are misidentified hash identifiers, external_commands are illustrative bash examples with hardcoded paths, and network/filesystem detections are benign markdown content. The skill-report.json explicitly marks risk_level as safe.

2
已掃描檔案
698
分析行數
3
發現項
5
審計總數

風險因素

🌐 網路存取 (5)
skill-report.json:16 skill-report.json:6 SKILL.md:3 SKILL.md:238 SKILL.md:240
📁 檔案系統存取 (2)
skill-report.json:6 SKILL.md:273
⚙️ 外部命令 (38)
SKILL.md:117-126 SKILL.md:126-131 SKILL.md:131-141 SKILL.md:141-144 SKILL.md:144-150 SKILL.md:150-155 SKILL.md:155-161 SKILL.md:161-164 SKILL.md:164-170 SKILL.md:170-184 SKILL.md:184-189 SKILL.md:189-201 SKILL.md:201-223 SKILL.md:223-227 SKILL.md:227-260 SKILL.md:260 SKILL.md:260-301 SKILL.md:301-305 SKILL.md:305-344 SKILL.md:344-348 SKILL.md:348-385 SKILL.md:385-391 SKILL.md:391-400 SKILL.md:400-404 SKILL.md:404-416 SKILL.md:416-420 SKILL.md:420-429 SKILL.md:429-431 SKILL.md:431-440 SKILL.md:440-486 SKILL.md:486-489 SKILL.md:124 SKILL.md:125 SKILL.md:133 SKILL.md:146 SKILL.md:117-126 SKILL.md:131-141 SKILL.md:144-150
審計者: claude 查看審計歷史 →

品質評分

38
架構
100
可維護性
87
內容
30
社群
100
安全
87
規範符合性

你能建構什麼

发布前文档审核

在发布前运行全面审核，确保文档符合质量标准并且所有功能都已文档化

文档贡献审核

检查新的文档提交是否完整、格式一致以及代码示例可正常工作，然后才进行合并

持续质量监控

跟踪文档覆盖范围随时间的变化，识别模块文档中的空白，并保持所有文档的样式一致

試試這些提示

快速验证 
验证此项目中的文档。报告总体得分，突出显示前3个问题，并显示模块README的覆盖百分比。
链接验证 
检查所有文档中损坏的链接。列出每个损坏的链接及其文件位置和行号，然后建议正确的路径或URL。
完整审核 
运行完整的文档审核。检查完整性、准确性、格式、链接和一致性。生成包含严重级别和优先级修复的详细报告。
覆盖分析 
分析模块文档覆盖范围。列出所有模块，检查README文件，报告缺失的文档，并建议创建缺失文档的优先顺序。

最佳實務

  • 在每次文档更新前运行快速验证检查，以便及早发现问题
  • 每月和重大发布前进行完整审核以保持质量标准
  • 使用优先级排序的建议，优先关注高影响的修复

避免

  • 跳过文档验证，仅依赖人工审核
  • 忽视损坏的内部链接，这会困扰在文档中导航的用户
  • 接受不同文档部分之间术语不一致

常見問題

此技能支持哪些文档格式？
此技能验证markdown文件。它检查docs/、source/和.claude/目录中的所有.md文件。
此技能可以自动修复损坏的链接吗？
不能。此技能会识别损坏的链接并建议修复，但需要人工审核和批准后才能进行更改。
此技能可以在私有仓库中使用吗？
可以。此技能使用平台工具来读取文件。外部链接验证需要网络访问。
完整的文档审核需要多长时间？
完整审核通常在一分钟内完成，适用于包含数百个文档文件的标准项目。
我可以将其集成到CI/CD流程中吗？
可以。将此技能与Claude Code CLI结合使用，可以在自动化构建流程中运行验证检查。
这与其他文档工具有什么不同？
此技能提供AI驱动的分析，并针对Logseq模板图结构提供上下文感知的定制建议。

開發者詳情

授權

MIT

儲存庫

https://github.com/C0ntr0lledCha0s/logseq-template-graph/tree/main/.claude/skills/docs-validator

引用

main

檔案結構

📄 SKILL.md