生产力
sync-readme
同步 README.md 与 README_ZH.md 文件内容,确保中英文说明文件内容一致且结构对齐。
简介
sync-readme 技能专为维护中英文双语文件项目的开发者所设计。通过自动比对 README.md 与 README_ZH.md,此工具能检测两者之间的差异、新增区段或过时内容,确保文件内容保持同步且一致。此技能对于使用 ai-rules-sync 或类似软件项目的开发人员特别有帮助,能有效降低维护多语言文件的技术负担。
-
自动判定更新时间点,选择正确的同步方向(从英文同步至中文,或反之)。
-
精确保留技术规格中的代码块、语言徽标、表格结构以及内部的链接格式。
-
强制执行技术词汇的统一性,例如将 rules 翻译为「规则」、commands 为「命令」、skills 为「技能」、agents 为「代理」、instructions 为「指令」等。
-
维持标题层级与结构的一致性,确保用户在切换语言时能拥有顺畅的阅读体验。
-
验证文件完整性,确保两份文件中的功能说明、设置示例以及工具对照表皆完全匹配。
-
此技能假设存储库根目录下同时存在 README.md 与 README_ZH.md 两个文件。
-
若双方文件皆有冲突性的更新,系统会提示用户确认何者为唯一的真理来源。
-
建议在完成重大功能更新或文件重构后执行此技能。
-
输入为标准 GitHub Markdown 格式,输出为自动更新后的本地化文件。
-
注意代码示例维持不变,仅针对叙述性文字与接口术语进行翻译,以确保文件具备专业且一致的技术表达标准。
仓库统计
- Star 数
- 27
- Fork 数
- 1
- Open Issue 数
- 2
- 主要语言
- TypeScript
- 默认分支
- main
- 同步状态
- 空闲
- 最近同步时间
- 2026年5月3日 18:39