ARTICLE DETAIL

资讯详情

深耕网站视觉设计与运营推广的一线实战洞察。

GitHub Copilot 指令文档本地化指南:基于 awesome-copilot 的 Markdown 本地化规范与实践

GitHub Copilot 指令文档本地化指南:基于 awesome-copilot 的 Markdown 本地化规范与实践 GitHub Copilot 指令文档本地化指南基于 awesome-copilot 的 Markdown 本地化规范与实践【免费下载链接】awesome-copilotCommunity-contributed instructions, agents, skills, and configurations to help you make the most of GitHub Copilot.项目地址: https://gitcode.com/GitHub_Trending/aw/awesome-copilot本篇技术指南围绕 localization.instructions.md 这一社区指令文档展开系统讲解在 GitHub Copilot 工作区中对 Markdown 技术文档进行本地化Localization的标准流程包括 locale 目录与命名规范、翻译完整性校验、图片与文档链接的处理策略以及免责声明的强制要求。读完本文你将掌握一套可直接执行的查找全部 Markdown → 翻译 → 落盘到localization/{{locale}}→ 行数比对 → 追加免责声明的完整本地化工作流并能结合仓库内日语、韩语指令文件实例理解其落地形态。文档定位与适用场景instructions/localization.instructions.md是 awesome-copilot 仓库中一条面向Copilot 本身的自定义指令Custom Instruction。它与其他指令文件一样通过 YAML frontmatter 声明元信息--- description: Guidelines for localizing markdown documents applyTo: **/*.md ---description一句话说明本指令的用途——为 Markdown 文档本地化提供指导。applyTo**/*.md表示该指令对工作区内所有 Markdown 文件生效一旦装入工作区Copilot 在遇到 .md 文件处理任务时就会自动遵循其中的规则。根据 instructions.instructions.md 的说明指令文件的典型用法是复制到工作区的.github/copilot-instructions.md或放在.github/instructions/目录下安装后即自动作用于 Copilot 行为。因此这条本地化指令适合文档维护者、开源项目翻译贡献者在需要把一批英文 Markdown 技术文档翻译为指定语言时要求 Copilot 以本地化专家身份执行任务。核心规则总览原文档将本地化任务定义为一条由若干硬性规则组成的流程任何一步都不能省略找出工作区内所有 Markdown 文档并将其本地化到给定的目标语言locale。所有本地化产物必须统一放置在localization/{{locale}}目录下。locale 命名必须遵循{{language code}}-{{region code}}格式。原文档中的每一个章节、每一个段落都必须被翻译不得遗漏任何部分。图片链接默认指向原始图片文档链接默认指向本地化后的文档外部链接除外。翻译完成后必须与原文比对结果尤其是行数行数不一致即说明存在缺失需逐行复查修正。每个本地化文档末尾必须追加免责声明且免责声明本身也要被本地化其中的链接始终指向 issue 页面。目录结构与 locale 命名规范统一输出目录所有本地化文档都应放入localization/{{locale}}目录而不是散落在原文旁边或随意新建目录。这一约定保证了多语言产物的可发现性与可维护性localization/ └── {{locale}}/ ├── guide.md ├── api-reference.md └── ...locale 格式语言代码 区域代码locale 的格式固定为{{language code}}-{{region code}}语言代码language code依据 ISO 639-1 标准如en、fr、ja、ko、pt、zh区域代码region code依据 ISO 3166 标准两位大写国家/地区代码如US、CA、JP、KR、BR、CN。原文档给出的合法示例locale含义en-us英语美国fr-ca法语加拿大ja-jp日语日本ko-kr韩语韩国pt-br巴西葡萄牙语zh-cn简体中文中国注意是language-region如zh-cn、pt-br这种带连字符的双段格式而非单一语言代码如zh或pt也不是大小写混用的pt-BR。目录名应与 locale 名完全一致例如localization/ja-jp/、localization/zh-cn/。翻译完整性不遗漏任何章节与段落这是本地化质量的生命线。原文档明确要求本地化原文档中的全部章节和全部段落在本地化过程中不得遗漏任何章节、任何段落DO NOT miss any sections nor any paragraphs。AI 翻译常见的失败模式是偷工减料长文档翻译到一半就压缩、合并、跳段。为对抗这一点原文档给出了一个极具操作性的校验手段——行数比对本地化完成后始终将结果与原文比较尤其是行数。如果每个结果的行数与原文不同则必然存在缺失的章节或段落应逐行复查并修正。在命令行中可以这样快速完成行数校验# 原文行数 wc -l docs/guide.md # 本地化产物行数 wc -l localization/zh-cn/guide.md当两者行数不一致时逐行line-by-line对照原文复查定位缺失的标题、列表项、代码块或表格行补齐后再重新比对。这一行数即完整性指标的策略把翻译是否完整从主观判断变成了可量化的客观检查。链接处理策略图片与文档链接本地化不是简单地把正文文字换成另一种语言文档内的引用关系同样需要正确处理。原文档给出了两条对应规则链接类型默认指向例外图片链接指向原始图片外部图片链接除外文档链接指向本地化后的文档外部文档链接除外图片指向原文图片资源通常不随语言变化架构图、截图等因此本地化文档中的图片应继续引用原始图片路径避免复制图片或制造失效链接文档链接指向本地化版本当文档 A 链接到同仓库的文档 B 时在本地化版本文档中应将该链接改写为 B 的本地化版本例如docs/guide.md→localization/zh-cn/guide.md保证读者在目标语言环境中点哪里都通外部链接保持原样指向仓库之外的绝对 URL如官方文档、规范标准无需改写直接保留。免责声明每个本地化文档的强制结尾本地化文档是机器翻译产物原文档要求在每个本地化文档的末尾追加免责声明其标准模板如下--- **DISCLAIMER**: This document is the localized by [GitHub Copilot](https://docs.github.com/copilot/about-github-copilot/what-is-github-copilot). Therefore, it may contain mistakes. If you find any translation that is inappropriate or mistake, please create an [issue](https://github.com/github/awesome-copilot/issues).同时必须遵守三条附加规则免责声明也要被本地化The disclaimer should also be localized——即追加到localization/zh-cn/下的文档时声明内容本身应翻译为简体中文而不是机械地粘贴英文原文声明中的链接始终指向 issue 页面Make sure the link in the disclaimer should always point to the issue page——无论本地化成什么语言其中的反馈链接都必须指向仓库的 issues 页面确保读者能便捷地报告翻译错误该声明追加在文档末尾并以---分隔与正文形成清晰边界。这条规则的价值在于机器翻译不可避免存在错误通过强制声明 固定的反馈通道把翻译可能有误的预期管理显性化并将质量改进闭环引导到 issue 流程。仓库中的本地化实践佐证指令文件的多语言实例awesome-copilot 仓库本身即是这条本地化指令的最佳应用样本。在 instructions/ 目录下可以看到同一指令文件的多语言形态csharp-ja.instructions.mdC# 开发指令的日语版本全文使用日文书写frontmatter 描述同样本地化为日文description: C# アプリケーション構築指針 by tsubakimotocsharp-ko.instructions.mdC# 指令的韩语版本frontmatter 描述为韩文。从这两个文件可以印证本地化指令在真实仓库中的落地要点正文全部翻译、frontmatter 中的 description 一并翻译、文件名保留英文原样csharp-ja/csharp-ko通过后缀标识语言而非重命名整个文件。这与本地化指令中本地化所有章节与段落的要求一致——连元数据描述也属于文档内容的一部分。其他本地化 Skill 的互补视角仓库中另有两个与本地化强相关的 Skill可与本文主题互相印证mkdocs-translations/SKILL.md面向 MkDocs 文档站的翻译 Skill同样要求按目标语言代码建目录、镜像原文目录结构、逐文件翻译不跳过、保留所有 Markdown 格式标题、代码块、元数据、链接并在文件末尾追加翻译署名。它与localization.instructions.md在目录化输出、镜像结构、逐文件不遗漏三方面高度一致说明这是社区公认的文档本地化范式。vscode-ext-localization/SKILL.md面向 VS Code 扩展的本地化 Skill展示了不同资源类型的本地化载体——package.nls.LANGID.json配置与命令、walkthrough/someStep.pt-br.mdwalkthrough 文档、bundle.l10n.LANGID.json源码字符串。它揭示了语言代码在扩展生态中的普遍用法如pt-br与指令文档中language-region的命名规范一脉相承。这些实例表明localization.instructions.md并非孤立规则而是与仓库内 i18n 生态共享同一套 locale 命名与不遗漏、保结构、留出处的质量原则。如何在 Copilot 中使用这条本地化指令结合 docs/README.instructions.md 与 instructions.instructions.md 的说明将这条本地化指令投入实战的步骤如下获取指令文件将 localization.instructions.md 加入工作区的指令集合——可以复制到.github/copilot-instructions.md或放到.github/instructions/目录下触发本地化任务在 Copilot 对话中给出明确指令例如找到仓库中所有 Markdown 文档并将它们本地化为zh-cnCopilot 会以本地化专家身份启动流程验收产物检查localization/zh-cn/目录是否创建、目录名是否符合language-region格式、每个文档是否结尾带本地化的免责声明并通过行数比对确认无章节遗漏。小结localization.instructions.md用一份精炼的规则清单定义了机器翻译技术文档这一任务的完整质量闭环统一的目录与 locale 命名localization/{{locale}}、ISO 639-1 ISO 3166保证产物可发现不遗漏章节段落 行数比对保证翻译完整图片指原文、文档链接指本地化版本保证引用关系不破裂强制免责声明 指向 issue 的反馈链接保证错误可回收、质量可持续改进。配合仓库内日语、韩语指令文件的真实样本这套规范可直接迁移到任何以 Markdown 为主体的文档仓库中落地执行。【免费下载链接】awesome-copilotCommunity-contributed instructions, agents, skills, and configurations to help you make the most of GitHub Copilot.项目地址: https://gitcode.com/GitHub_Trending/aw/awesome-copilot创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表