mcpField
G
good-docs-audit

good-docs-audit

github.com/composiohq文档处理30.8k117 次安装今天更新
代码仓库

关于 good-docs-audit

按 `good-docs-writing` 规则审查文档写作并报告具体偏差的技能。默认只提供审查结果;只有在明确要求时才修改文件。

主要功能

  1. 01以写作规则作为审查标准
  2. 02为每项发现标注文件和行号
  3. 03引用问题原文并提供改写
  4. 04默认只报告、不编辑

适用场景

  1. 01检查文档是否偏离写作风格
  2. 02生成可执行的审查结果而不编辑文件
  3. 03在明确要求时改写文档

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/composiohq/composio --skill good-docs-audit

安装后在 Claude Code 中输入/good-docs-audit确认已加载。

附带文件references/audit-process.md

详细介绍

好文档审查

依据 good-docs-writing 规则审查目标文档,找出文字风格偏离该规范之处并给出报告。默认行为是仅报告:生成审查结果,不做编辑。只有当用户明确要求修复、重写或应用时,才修改文件。

阅读 references/audit-process.md,了解审查流程、按优先级排列的违规检查清单、报告格式及报告规则。

不可妥协的要求:

  • 先阅读 good-docs-writing(及其 references/style-guide.md)。这些规则是评判标准;本 Skill 只规定流程。
  • 每条发现都要标注 file:line,并原文引用有问题的文字。
  • 给出符合目标风格的实际改写,而不是"建议修改"。
  • 不要虚构违规。简短的报告也是好结果。

评论

支持 Markdown