SuperAPI AI 工具集

docs-check-compliance

写作与研究

查看项目

更新于 10-16 06:51

技能介绍

用途:对一个文档文件按指定规则技能进行合规审计、修复与编译验证。

主要能力:加载规则技能后,逐条建立检查清单并系统性验证;发现违规后用最小改动修复,每条规则单独提交;最后运行 mdoc 验证文档可编译。

使用方式:两个参数——docs-file(文档路径,如 docs/reference/xml.md)与 rule-skill(规则技能名,如 docs-writing-style、docs-mdoc-conventions)。需先用 Skill 工具加载该规则技能,再用 Read 工具读取完整文档(使用从 <PROJECT_ROOT>/ 开始的绝对路径)。然后逐条处理:先以对抗式验证找出违规(引用行号与原文),做最小编辑修复,立即提交,如: git add <docs-file> git commit -m "docs(<docs-file-stem>): fix <rule-name>" 最后编译: sbt "docs/mdoc --in docs/reference/chunk.md --out website/docs/reference/chunk.md" --out 为同一路径加上 website/ 前缀;不要裸跑 sbt docs/mdoc。若 mdoc 失败,定位错误、修复并提交 git commit -m "docs(<docs-file-stem>): fix mdoc error"。最后报告各规则违规数与修复情况、零违规规则、mdoc 最终状态。

适用场景:文档仓库中对单个文档执行规则化审查与修复,尤其配合 mdoc 文档构建流程。

限制:规则技能若为编号列表则按编号建清单,若为决策树或命名检查(如 docs-mdoc-conventions 的 modifier selection、public-symbols-only、admonition frequency)则按命名点建清单。必须逐条完整核对,不得跳过或未验证即认定合规;每次修复单独提交,避免批量提交。其他实现细节、适用平台与收费信息暂未提供。