README 国际化(i18n)技能用于维护 README 的多语言版本,确保中文与英文内容对照同步。
用途
该技能面向需要维护中英双语 README 的项目,帮助开发者在文档更新时同步两个语言版本,避免内容脱节。
触发条件
- 使用者说「更新 README」「sync readme」「翻译 README」
- README.md 有变更时
- 新增功能需要更新文档时
使用方式
执行流程包括以下步骤:
-
确认变更来源:如果使用者提供中文内容,同步到英文版;如果提供英文内容,同步到中文版;如果主 README 变更,同步两个版本。
-
主 README 格式:主 README.md 采用双语并列格式,顶部使用语言切换链接,每个章节先中文后英文,或使用折叠区块分隔。
-
翻译原则:技术术语保持一致并建立术语表;代码示例不翻译,只翻译注释;保持 Markdown 结构完全对应;链接指向对应语言版本。
-
同步检查:核对章节数量一致、代码区块一致、链接有效性、术语一致性。
文件结构
- README.md:主 README(英文,Primary)
- README.zh-TW.md:繁体中文版本(对照翻译)
术语对照表
文档提供了以下术语对照:宪法 Constitution、子法 Bylaws、技能 Skills、记忆库 Memory Bank、领域驱动设计 Domain-Driven Design (DDD)、资料存取层 Data Access Layer (DAL)、提交 Commit、工作流 Workflow、架构 Architecture、模组化 Modular、跨对话 Cross-conversation。
输出模板
主 README.md 顶部可使用双语标题与语言切换链接,例如:
Project Name / 专案名称
English | 繁体中文
或使用独立文件链接:
Project Name
English | 繁体中文
依赖
该技能依赖 readme-updater 提供基础 README 更新逻辑。
注意事项
翻译时保持语气一致(专业但亲切);不要过度意译,保持技术准确性;Emoji 两个版本保持一致;更新日期同步标记。
限制
资料中未提供该技能的具体安装方式、运行环境要求、支持平台、收费信息及实际使用效果,暂未提供。