AIOX多语言文档工作流:翻译规范与i18n目录结构完整指南
【免费下载链接】aiox-coreSynkra AIOS: AI-Orchestrated System for Full Stack Development - Core Framework v4.0项目地址: https://gitcode.com/GitHub_Trending/ai/aiox-core
Synkra AIOX(面向全栈开发的 AI 编排系统)内置了一套成熟的多语言文档工作流,围绕AIOX 文档国际化(i18n)展开:英文为源语言,葡萄牙语、西班牙语、简体中文各按统一目录结构镜像存放,并配套翻译规范、术语表与质量审核流程。本文带你快速看懂 AIOX 的 i18n 目录结构与翻译规范,适合准备参与文档翻译的新手。
一、i18n 目录结构:每种语言一个镜像目录
AIOX 的多语言文档没有使用复杂的翻译文件,而是采用最直观的"语言代码子目录"方案:英文文档放在 docs/ 根目录,其余语言放在docs/下的对应子目录中,目录树与英文完全对齐。
docs/ ├── getting-started.md # 英文(源语言,位于根目录) ├── guides/ # 英文指南 ├── installation/ # 英文安装文档 │ ├── pt/ # Português 葡萄牙语 │ ├── getting-started.md │ └── guides/ ├── es/ # Español 西班牙语 │ ├── getting-started.md │ └── guides/ └── zh/ # 简体中文(进行中) ├── getting-started.md ├── GLOSSARY.md # 中文术语表 └── TRANSLATION-PLAN.md # 翻译计划各语言入口文件一览:
| 语言 | 目录 | 状态 | 入口文档 |
|---|---|---|---|
| English | 根目录 | ✅ 完整 | docs/getting-started.md |
| Português | docs/pt/ | ✅ 完整 | docs/pt/README.md |
| Español | docs/es/ | ✅ 完整 | docs/es/README.md |
| 简体中文 | docs/zh/ | 🟡 进行中 | docs/zh/README.md |
💡核心规则:译文路径 = 原文路径 + 语言前缀。例如英文
installation/macos.md的中文版本就是zh/installation/macos.md,一一对应、便于机器检查覆盖率。
中文文档首页还附有一份完整度审查表(对比 PT 覆盖率 85.2%、ES 覆盖率 86.4%),并列出了当前主要缺口文件清单,想参与翻译时可优先补齐这些文件,详见 docs/zh/README.md。
二、翻译规范:术语表与 5 条核心原则
多语言文档最容易"翻着翻着就乱",AIOX 靠两个机制保证一致性:
1. 统一术语表(Glossary)
docs/zh/GLOSSARY.md 定义了核心术语的标准译法,同时给出简体、繁体两版对照。摘录部分:
| 英文 | 简体中文 | 备注 |
|---|---|---|
| Agent | 代理 | 核心概念 |
| Workflow | 工作流 | 任务执行顺序的流程 |
| Greenfield | 绿地项目 | 从零开始的新项目 |
| Brownfield | 棕地项目 | 在现有代码上开发 |
| Gate | 门控 | 质量检查点 |
| MCP / SYNAPSE | MCP / SYNAPSE | 不翻译 |
2. 五条翻译原则
出自 docs/zh/TRANSLATION-PLAN.md:
- 保持技术准确性—— 术语优先使用行业标准译法,先查术语表
- 代码不翻译—— 代码块、变量名、命令一律保留英文
- 保留品牌名—— Synkra、AIOX、Claude 等品牌名不翻译
- 链接更新—— 文档内部链接指向对应语言的版本
- 同步标记—— 每个文件头部标注原文路径与同步日期
3. 文件头模板:每个译文文件都要带"身份证"
<!-- 翻译:zh-CN(简体中文) 原文:/docs/en/{path} 最后同步:YYYY-MM-DD 翻译者:{name} 审核者:{name} -->文件顶部还固定放一行语言切换导航,例如 docs/zh/README.md 第一屏就是:
🌐 EN | PT | ES |ZH
让读者在任何一篇文档里都能一键跳回其他语言版本。
三、分阶段翻译工作流:先核心、后扩展
AIOX 的翻译不是"来一篇翻一篇",而是一套分优先级(Tier)的流水线,完整规划见 docs/zh/TRANSLATION-PLAN.md:
| 阶段 | 范围 | 文件数 | 目标 |
|---|---|---|---|
| 第一阶段 Tier 1 | 快速入门、安装、核心架构 | ~25 | 让用户能装、能用 |
| 第二阶段 Tier 2 | 代理流程(12 篇)+ 工作流(11 篇) | ~35 | 理解代理系统 |
| 第三阶段 Tier 2 | 架构文档 | ~20 | 深入理解系统 |
| 第四阶段 Tier 3 | 安全、MCP、Squad 等高级指南 | 50+ | 完善覆盖 |
| 第五阶段 Tier 4 | 示例与社区文档 | 30+ | 完整覆盖 |
执行节奏按周推进:第 1 周搭目录结构与术语表 → 第 2–3 周核心文档 → 第 4–5 周代理系统 → 第 6 周架构文档 → 第 7–10 周高级指南与社区文档,最后统一审核校对。
四、质量保障:四步审核 + 自动化检查
译文合并前要经过一条质量流水线:
初译 → 技术审核 → 语言审核 → 合并- 初译:完成初步翻译
- 技术审核:确保技术准确性
- 语言审核:确保语言流畅性
- 合并:PR 审核通过后合并
同时配有 4 项自动化检查清单:内部链接有效、Markdown 格式正确、术语使用一致、代码块未被误译。
五、新手上手:5 步参与 AIOX 文档翻译
如果你也想贡献译文,流程非常简单:
- 克隆仓库:
git clone https://gitcode.com/GitHub_Trending/ai/aiox-core - 打开 docs/zh/README.md 的"当前主要缺口"清单,选一篇待翻译文档
- 创建分支,命名规范为
zh/translate-{filename} - 按 翻译计划 的规范翻译:查术语表、加文件头、保留代码块、更新内部链接
- 提交 PR(PR 模板已内置检查清单:遵循术语表 / 添加文件头 / 更新链接 / 代码块保持英文)
译文同步维护
翻译完成后并非一劳永逸。AIOX 的维护策略是:每个文件记录原文版本 → 监控英文文档变更 → 每月检查同步 → 原文更新时自动创建提醒。这样各语言版本不会悄悄"过期"。
六、小结
AIOX 的多语言文档工作流可以归纳为三句话:
- 结构上:
docs/{语言代码}/镜像目录,路径一一对应,覆盖率可量化 - 规范上:术语表 + 5 条翻译原则 + 文件头同步标记,保证多语言一致性
- 流程上:Tier 分阶段推进 + 四步审核 + 自动化检查,质量有兜底
这套模式通用性很强,如果你想为自己的开源项目搭建 i18n 文档体系,可以直接参考 AIOX 的目录设计与 翻译计划 模板。
【免费下载链接】aiox-coreSynkra AIOS: AI-Orchestrated System for Full Stack Development - Core Framework v4.0项目地址: https://gitcode.com/GitHub_Trending/ai/aiox-core
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考