多语文档生成
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @kunlungrowth/multi-lang-readme。
技能介绍
解决什么问题
维护多语言 README 最常见的问题是:结构漂移、链接失效、代码块被误译,以及语言之间缺少稳定的切换入口。不同语言版本一旦各自演进,读者就很难在文档间跳转,维护者也会反复手工对齐标题、章节和导航。
这个技能把项目文档中的 README 本地化收敛成一次可重复的流程:保留源文件的 Markdown 骨架,生成命名规范的译文,并在每个版本顶部补上语言切换行,使多个语言版本看起来像同一个文档的不同视图。
它如何工作
核心能力包括:
- 结构保持:标题、章节、徽章、列表与正文按目标语言重写,但 Markdown 结构保持稳定,方便后续 diff 和持续维护。
- 代码与链接保护:
代码块不翻译;相对链接路径保持不变;外链锚文本可按目标语言优化,但不改变跳转目标。 - 命名规范:默认将
README.md作为英文主版本;其他语言按README.de.md、README.ja.md、README.ko.md、README.zh-CN.md等规则落盘。 - 导航补齐:在各语言文件顶部插入切换行,例如
**English** | 中文,并在译文中增加返回主文档或跨语言互链,避免孤立页面。
工作流分为八个步骤:
- 定位:默认读取根目录
README.md;存在多个 README 时先让用户指定目标文件。 - 读取:完整解析标题、徽章、Features / Installation / Usage / Contributing / License 等章节,以及代码块和链接。
- 确认语言:询问目标语言;只说“双语”时,按英文
README.md+ 中文README.zh-CN.md执行。 - 翻译:保留 Markdown 结构,代码块不译,标题与正文译为目标语言,相对链接路径不变。
- 写文件:按命名规范写入各语言 README。
- 补切换:在每个语言文件顶部加入语言切换导航。
- 互链:在译文中增加返回主文档或多语言互链。
- 校验:检查路径、链接、格式一致性与导航完整性,并返回包含主版本、译文路径和切换链接的
ReadmeSetArtifact。
适用边界与注意点
它只处理项目 README,不用于翻译非 README 的通用文档、与 README 无关的内容创作,也不用于法律、合同等高风险文档翻译。
使用前要确认默认英文主版本策略是否符合项目现状;如果当前主 README 不是英文,技能会先把英文版本转为主版本,再生成其他语言。译文中的外链锚文本可以优化表达,但不应改变相对路径或跳转目标。
使用场景
- 开源项目要同时面向中英文用户,需要为根目录 README.md 生成结构一致的中文版并互设语言切换链接
- 仓库已有英文 README,想新增 README.zh-CN.md,同时确保代码块、相对链接路径不被改动
- 项目被用户要求提供多语言文档,需要在文件顶部统一加入类似 **English** | 中文 的切换导航
- 仓库里同时存在多个 README 文件,需要先指定目标文件,再按命名规范生成德、日等指定语言版本
适合人员
- 开源项目维护者:希望项目同时吸引中英文用户,需要让多语言 README 结构一致、可互相跳转
- 技术文档工程师:负责 README 本地化,需要保留 Markdown 结构与代码块,只替换语言内容
- 独立开发者:不熟悉语言切换导航写法,希望自动在译文顶部补上切换行和返回主文档链接
- 社区贡献者:想为项目补充中文文档,担心翻译时破坏原有章节顺序和链接路径