documentation-review

负责审查技术文档的事实准确性,核实工具功能描述、代码示例、格式规范及链接有效性,确保所有内容与系统实际行为一致,并以待办事项形式结构化呈现问题点供人工复核。

快捷安装

在终端运行此命令,即可一键安装该 Skill 到您的 Claude 中

npx skills add Microck/ordinary-claude-skills --skill "documentation-review"

Generating Commit Messages

Instructions

  1. Read the documentation you are instructed to review
  2. Make sure that all claims about how toolhive works are accurate
  3. Make sure that all examples are based in how toolhive really works, check for formatting, typos and overall accuracy
  4. Make sure that all links point to existing files and the content of the links matches what it should

Fact-checking claims in the documentation

See CHECKING.md on instructions on how to check claims in the docs.

You have some examples on how to fact-check in EXAMPLES.md

Your report

  • Do not suggest inline changes
  • Present findings and put each into a todo list. The user will then go through them and review manually