SuperAPI AI 工具集

readme-i18n

写作与研究

查看项目

更新于 10-16 10:22

技能介绍

用途:维护 README 的多语言版本,确保中文与英文内容对照同步。当使用者说「更新 README」「sync readme」「翻譯 README」、README.md 有变更,或新增功能需要更新文档时触发。

主要能力与文件结构:主 README 为英文(Primary),中文版本作为对照翻译,例如 README.md 与 README.zh-TW.md。执行流程为:先确认变更来源,若提供中文内容则同步到英文版,若提供英文内容则同步到中文版,若主 README 变更则同步两个版本。主 README 可采用双语并列格式,在顶部放置语言切换链接;也可用折叠区块分隔。

翻译原则:技术术语保持一致并建立术语表;程式码范例不翻译,只翻译注解;保持 Markdown 结构完全对应;链接指向对应语言版本。同步检查清单包括章节数量一致、程式码区块一致、链接有效性、术语一致性。术语对照表示例:宪法/Constitution、子法/Bylaws、技能/Skills、记忆库/Memory Bank、领域驱动设计/Domain-Driven Design (DDD)、资料存取层/Data Access Layer (DAL)、提交/Commit、工作流/Workflow、架构/Architecture、模组化/Modular、跨对话/Cross-conversation。

输出范式:主 README.md 顶部可写 Project Name / 專案名稱,然后提供 English 与 繁體中文 的锚点链接,或使用独立档案链接如 README.en.md 与 README.zh-TW.md。

依赖:readme-updater,提供基础 README 更新逻辑。

限制与注意事项:翻译时保持语气一致(专业但亲切);不要过度意译,保持技术准确性;Emoji 两个版本保持一致;更新日期同步标记。上述资料未提供平台限制、收费价格或安装命令等信息。