菜单

翻译架构

相关源文件

本文档描述了 ML-For-Beginners 存储库的翻译架构,详细说明了课程是如何组织的以支持多种语言。它涵盖了文件组织、翻译工作流程和为使教育内容能够被全球受众访问所做的贡献流程。

概述

ML-For-Beginners 课程在设计时就考虑了国际化,允许将教育材料翻译成多种语言。翻译架构为组织翻译内容提供了一致的结构,并为贡献者添加新翻译提供了指南。

主要目标

  • 提供多种语言的完整课程访问
  • 在所有翻译中保持一致的结构
  • 支持社区对翻译的贡献
  • 确保翻译内容与英文源材料保持同步

文件结构

存储库遵循特定的结构来组织原始内容(英文)及其翻译。

来源

主要翻译模式

存储库遵循两种主要模式来组织翻译:

  1. 根目录翻译目录:包含主 README 和其他根目录文档的翻译。
  2. 特定课程翻译目录:每门课程或章节可能包含自己的 translations 目录。

来源

翻译命名约定

文件遵循一致的命名约定来识别其语言。

模式示例描述
{文件名}.{语言代码}.mdREADME.es.mdREADME 的西班牙语翻译
translations/{文件名}.{语言代码}.mdtranslations/assignment.ja.mdassignment 的日语翻译

语言代码遵循 ISO 语言代码,有时也会包含地区限定符(例如,巴西葡萄牙语使用 pt-br)。

翻译工作流程

下图说明了存储库内容翻译的典型工作流程。

来源

支持的语言

课程目前支持以下语言,完成度各不相同:

语言代码主 README课程覆盖情况
英语en✅ (原文)✅ (原文)
西班牙语es部分
日语ja部分
中文(简体)zh-cn部分
土耳其语tr部分
葡萄牙语pt, pt-br部分
意大利语it部分
韩语ko部分
印地语hi最小
Tamilta最小
马来语ms最小

来源

翻译组件

课程的以下组件通常会被翻译:

来源

测验本地化

通过专门的测验应用程序,测验提供多种语言版本。

来源

翻译贡献流程

下图说明了翻译的贡献流程。

来源

翻译维护

随着英文原版内容的更新,翻译也必须保持同步。

来源

技术实现

翻译系统主要基于文件,除了存储库的目录结构之外,没有特殊的技​​术实现。该系统依赖于 GitHub 的工作流程来进行贡献和更新。

为了离线访问文档,该存储库支持使用 Docsify。

来源

PDF生成

该存储库还支持生成课程的 PDF 文件。

来源

结论

ML-For-Beginners 的翻译架构使全球受众能够以其首选语言访问课程。通过一致的文件组织和社区贡献,该存储库维护了多种语言的翻译,使机器学习教育在全球范围内更容易获得。