Can I include ko-kr translation workflow assets in the repository?
Background
I recently translated docs/ko-kr/stage-2/frontend/lovart-assets/index.md using a local Chinese-to-Korean translation workflow.
Since the documentation is large, I wanted to keep the Korean translation consistent in terminology and writing style, make it easier to review, and help future contributors maintain it more easily. During this process, I created several local assets related to terminology, Korean writing style, and automated checks.
I would like to ask which of these assets, if any, would be appropriate to include in the repository.
I have also opened a PR with the rewritten stage-2/frontend/lovart-assets translation, so maintainers can compare the existing translation and the rewritten version to check the actual quality difference at a more granular level.
Assets I created locally
Tool-agnostic assets
The following assets are not tied to a specific AI tool and may be useful for future ko-kr contributors.
| Asset | Purpose |
|---|---|
translation/glossary.md |
Chinese → Korean terminology glossary. It defines standard Korean terms, whether English names should be kept as-is, and forbidden alternatives to prevent inconsistent wording. |
translation/style-guide.md |
Korean writing style guide for avoiding literal translation patterns and keeping the translated documentation natural. |
translation/check-translation.mjs |
Node-based mechanical checker for structure parity, image paths, inline code preservation, remaining Chinese text, links, and optional build validation. |
translation/glossary-candidates.md |
Temporary place to collect newly discovered terms before they are approved and added to the glossary. |
translation/progress.md / translation/qa-log.md |
Files for tracking translation progress and QA history. |
Tool-specific assets
I also created Claude Code-specific files locally.
- translator / reviewer / sample-grader agents
- chapter-level translation command
- Claude-specific translation rules
These files are useful for my own workflow, but they are tied to Claude Code. Unless the maintainers think they would be useful as reference material, I currently plan to keep them local.
Current workflow summary
The current workflow is roughly as follows:
- Translate based on the glossary and Korean style guide.
- Run mechanical checks for structure, links, image paths, inline code preservation, remaining Chinese text, and build safety.
- Compare the Chinese source and Korean translation to review mistranslations, omissions, hallucinations, and terminology violations.
- Use random sample review to check Korean readability.
- Feed human corrections back into the glossary and style guide.
The goal is not to make AI-tool-specific files mandatory, but to keep ko-kr translation quality consistent and easier to review.
Questions
Would it be acceptable to include tool-agnostic translation assets such as
glossary.md,style-guide.md, andcheck-translation.mjsin the repository?If yes, where would you prefer these files to live?
translation/docs/ko-kr/translation/- another location
Should progress/history files such as
progress.md,qa-log.md, andglossary-candidates.mdalso be included, or should they remain local?The Claude Code-specific files are still being revised and improved as part of my personal workflow, so I currently plan to keep them local and not include them in the repository.
标题
[问题] 是否可以将 ko-kr 翻译工作流相关资产加入仓库?
背景
最近我使用本地的中→韩翻译工作流,翻译了 docs/ko-kr/stage-2/frontend/lovart-assets/index.md。
由于文档篇幅较大,我希望韩文翻译在术语和文体上保持一致,同时也更容易审校,并方便后续贡献者维护。在这个过程中,我在本地创建了一些与术语、韩文写作风格和自动检查相关的资产。
我想请教一下,这些资产中哪些适合加入到仓库中。
此外,我也已经提交了一个 PR,其中包含使用该工作流重写后的 stage-2/frontend/lovart-assets 韩文译文。维护者可以对比原有译文和重写后的版本,从更细粒度上确认实际的翻译质量差异。
我在本地创建的资产
与工具无关的资产
以下资产不依赖特定的 AI 工具,我认为它们可能对后续 ko-kr 贡献者也有帮助。
| 资产 | 用途 |
|---|---|
translation/glossary.md |
中→韩术语表。用于定义标准韩文术语、英文名称是否保留,以及为了避免表述不一致而禁止使用的替代译法。 |
translation/style-guide.md |
韩文写作风格指南,用于避免直译腔,并让翻译后的文档保持自然的韩文表达。 |
translation/check-translation.mjs |
基于 Node 的机械检查脚本,用于检查结构一致性、图片路径、行内代码保留、中文残留、链接,以及可选的构建验证。 |
translation/glossary-candidates.md |
用于临时收集新发现的术语,在确认后再加入正式术语表。 |
translation/progress.md / translation/qa-log.md |
用于追踪翻译进度和 QA 历史记录。 |
与工具相关的资产
我也在本地创建了一些 Claude Code 专用文件。
- translator / reviewer / sample-grader agents
- 按章节执行的翻译命令
- Claude 专用翻译规则
这些文件对我自己的工作流很有用,但它们依赖 Claude Code。因此,除非维护者认为它们作为参考资料有价值,否则我目前计划只在本地保留它们。
当前工作流概述
当前工作流大致如下:
- 基于术语表和韩文风格指南进行翻译。
- 对结构、链接、图片路径、行内代码保留、中文残留以及构建安全性进行机械检查。
- 对照中文原文和韩文译文,检查误译、遗漏、幻觉内容和术语违规。
- 通过随机抽样审校来检查韩文可读性。
- 将人工修改内容反馈回术语表和风格指南。
目标并不是强制使用某个 AI 工具专用的文件,而是让 ko-kr 翻译质量保持一致,并且更容易 review。
问题
是否可以将
glossary.md、style-guide.md、check-translation.mjs这类与工具无关的翻译资产加入仓库?如果可以,您更希望这些文件放在哪里?
translation/docs/ko-kr/translation/- 其他位置
progress.md、qa-log.md、glossary-candidates.md这类进度/历史记录文件也适合加入仓库吗?还是保留在本地更好?Claude Code 专用文件目前仍是我个人工作流的一部分,并且还在持续修改和完善中,所以我目前计划只在本地保留,不加入仓库。
Source: datawhalechina/easy-vibe