SuperAPI AI 工具集

hns-oss-docs-readme-sync

写作与研究

查看项目

更新于 10-16 01:18

技能介绍

用途:为仓库根目录的 README 四文件集(README.ko.md、README.md、README.ja.md、README.zh.md)提供同步流程。韩文 README.ko.md 为主源(canonical),英、日、中三版为派生文件。历史上主源曾为英文,2026-08-17 起改为韩文,以与文档站链保持一致。

主要能力与用法:先在 README.ko.md 中撰写改动,遵循韩文版章节骨架并控制文件长度;在同一 PR 内派生 en、ja、zh,每个派生文件由一名翻译 worker 处理,仅最小化翻译改动章节,不重写未触及内容。四文件须逐字保留代码块、命令名、徽章、版本字符串、文件路径、表格结构、Mermaid 方向以及切换头。

语言切换头为硬性约定:四文件顶部共享同一切换头,标签固定为 English · 한국어 · 日本語 · 中文,当前文件标签为纯文本,其余三个为链接,不得重排、删除或改标签。

校验清单:用 grep -c '^## ' 检查四文件 H2 数量一致;H2 顺序与韩文版一致;改动章节的 H3 数量、表格行数一致;代码块计数为偶数且相等;切换头存在且正确;URL 黑名单检查 grep -n 'docs.moai-ai.dev|adk.moai.com|adk.moai.kr' README*.md 无匹配。无专用 linter,需人工按上述配方校验,并预览 GitHub 风格 Markdown,确认 Mermaid 仅声明 TD/TB。可运行的文档站检查位于 Skill("hns-oss-docs-verify")。

限制与反模式:不要先改 README.md;不要为三行改动重写整个派生文件;翻译时不得“改进”事实或数字,应报告差异并先修正主源;重构时不得丢弃切换头。