SuperAPI AI 工具集

dify-docs-format-check

写作与研究

查看项目

更新于 10-15 21:35

技能介绍

用途:对 Dify 文档变更做只读格式合规审查,覆盖英文、中文、日文文档,规则来源为 writing-guides/formatting-guide.md 以及 tools/translate/formatting-zh.md、formatting-ja.md。

主要能力:按路径分流检查。en/ 文件用 check-format-en.py,zh/ 与 ja/ 文件用 check-format-cjk.py(脚本按路径选择中文或日文规则集)。脚本输出逐文件违规行,格式为 line [rule-id] message,并以 Total violations: {n} 结束,n=0 时退出码为 0,否则为 1。规则 ID 家族包括 F- frontmatter、H- 标题、B- 粗斜体、L- 列表、C- 代码、Li- 链接、I- 图片、M- Mintlify 组件、U- UI 元素引用(仅英文)、S- 间距、P- 标点、CJK- 中日共用、ZH- 仅中文、JA- 仅日文。

使用方式:先读取范围内语言的规则源文件,再检测待审文件(默认当前审查中的文件,可用 git diff --name-only、git diff --cached --name-only、git status --porcelain | grep '^??' 获取),仅保留 en/、zh/、ja/ 下的 .mdx/.md 文件;未检测到则询问用户。随后运行:python3 .claude/skills/dify-docs-format-check/check-format-en.py <en files...> 与 python3 .claude/skills/dify-docs-format-check/check-format-cjk.py <zh and ja files...>,并将输出原样粘贴到报告。再用 python3 tools/check-parity.py --base origin/main <changed pages...> 检查三种语言结构一致,成功信号为 PARITY OK: {n} pages。

判断类审查:英文检查标题大小写、粗体用途、列表标点一致性、链接文本、图片 alt 与命名、表格对齐、Mintlify 组件内容;中文与日文检查可翻译元素、锚点 slug、中文标点与数字用法、日文文体与片假名规范等。

限制:本技能为只读审计,不修改任何文件;术语与 UI 标签措辞核对属于 dify-docs-terminology-check,不在此检查。日文句长与文体混用检查为启发式,仅供人工复核。修改 CJK 检查器时需运行 test_check_format_cjk.py,回归套件须以 OK 结束且退出码为 0。