Dev Flow 文档国际化策略

September 2, 2026 · View on GitHub

中文 | English

适用范围

本策略管理仓库中的人类可读文档,不定义产品运行时 locale。运行时行为仍以源码、机器可读 Schema、package manifest、CLI parser 和可执行测试为准。

权威产品文档语言

英文和简体中文是持续同步的权威产品文档语言。以下文档族同时维护两种语言:

  • README.md(英文默认入口)与 README_zh-CN.md(简体中文入口);
  • docs/PRODUCT*docs/DEMO*docs/ROADMAP*docs/PROJECT-STATUS*
  • docs/ARCHITECTURE*docs/COMMANDS*docs/WEBUI*docs/SUPPORT-MATRIX*
  • MANIFEST*CONTRIBUTING* 与本 I18n 策略;
  • Codex 和 DeepSeek 当前已有的中英文 Host 文档。

这两种语言必须同步产品定位、当前能力、未来方向、命令、平台、Host 和安全边界。技术参考继续只 维护简体中文与英文。

根 README locale

根 README 保留以下 9 个 locale:

Locale语言文件维护角色
enEnglishREADME.md持续同步的默认产品入口
zh-CN简体中文README_zh-CN.md持续同步的简体中文产品入口
zh-TW繁體中文README_zh-TW.md社区翻译或稳定文档快照
ja日本語README_ja.md社区翻译或稳定文档快照
ko한국어README_ko.md社区翻译或稳定文档快照
esEspañolREADME_es.md社区翻译或稳定文档快照
frFrançaisREADME_fr.md社区翻译或稳定文档快照
deDeutschREADME_de.md社区翻译或稳定文档快照
pt-BRPortuguês do BrasilREADME_pt-BR.md社区翻译或稳定文档快照

README_en.md 只保留指向 README.md 的兼容提示,避免旧外部链接失效;它不是英文权威入口,也不 进入 locale 导航。

其他七个 locale 不再承诺与每次源码提交逐段同步。它们至少要准确保留核心定位、主要能力、边界、 推荐安装入口、selector、稳定支持范围和权威文档链接。未跟上英文/简中当前内容时,文件顶部必须 明确标注为稳定文档快照,并引导读者查看 README.mdREADME_zh-CN.md 的当前说明。

同步规则

用户可见行为或产品定位变化时:

  1. 同步英文和简体中文对应文档族;
  2. 更新所有受影响的技术参考和 Host 文档;
  3. 检查其他七个根 README 是否仍准确描述核心定位、能力、边界、命令和稳定支持;
  4. 能完整同步时更新翻译;暂时不能完整同步时保留准确快照说明,不得扩大或虚构当前能力;
  5. 在 Pull Request 验证说明中列出实际更新的路径和仍为快照的 locale。

其他语言不得增加简中/英文中不存在的能力、平台或支持声明。命令、selector、package 名、路径、 版本身份和 Support Matrix 事实不得因翻译而改变。

安装命令与版本身份

面向普通用户的安装示例使用 npm 稳定 channel:

@imotong/dev-flow@latest
dev-flow-codex@latest
dev-flow-deepseek@latest

Core、Codex、DeepSeek 和 Dev Flow CLI 的精确产品版本只保存在机器可读版本文件、package metadata、 Release Tag、制品 digest 和发布记录中。人类文档不写入精确产品版本。

命令说明必须对照实际实现:

  • package 名称、bin 和平台约束来自对应 package.json
  • Codex 命令来自 packages/codex/bin/dev-flow-codex.mjs
  • 统一 lifecycle 命令来自 packages/dev-flow/lib/cli.mjs
  • DeepSeek 安装与移除形态来自 DSH lifecycle tests;
  • packaged Core 命令来自 cmd/dev-flow/main.go
  • MCP 工具来自 internal/mcp/ 的闭合目录。

翻译不变量

所有 locale 必须保持以下内容一致:

  • Dev Flow 的主要定位和首要失效场景;
  • 当前能力与未来方向的区别;
  • 命令、selector、工具名、环境变量、路径和文件名;
  • package、bundled Core、平台与 Host 兼容范围;
  • 能力、非目标、安全边界和支持声明的含义;
  • 指向当前简中/英文技术参考的链接。

叙述可以按目标语言自然表达。没有稳定译法的标识符保留英文,不为不同语言发明额外产品术语或 承诺。

审查要求

文档变更至少检查:

  • 语言导航中的所有文件存在;
  • 简中和英文文档族表达同一产品事实;
  • 其他根 README 没有与当前定位、命令、平台或边界冲突;
  • 快照文件明确标注状态并链接到当前简中/英文入口;
  • 所有普通安装示例使用 @latest
  • 非英文文件没有占位翻译或整段英文 fallback;
  • docs/COMMANDS* 与当前 parser、lifecycle tests 和 MCP catalog 一致。