以下内容截取自 针对 MDN 文档的本地化指南 的中文翻译的常见问题小节。 其中翻译的规范也是中文写作的规范,更多详见之前写的 中文技术文档的写作规范。
为保证简体中文文档格式的一致性,翻译指南列出了部分规范。
除了代码中使用的符号以及一些特殊情况外,请将英文(半角)符号替换成中文(大部分为全角)符号。
但请注意,请不要使用全角数字(特殊情况除外)。
示例如下:
我们可以学习 JavaScript——一种很酷的语言
我们可以学习 JavaScript--一种很酷的语言
以下示例是“可交互的”
以下示例是"可交互的"
另外,请注意并列的词语间应使用顿号而非逗号:
a, b, and c
a、b 和 c
a,b,和 c
名称 | 中文 | 英文 |
---|---|---|
括号 | () | () |
冒号 | : | : |
引号 | “” | "" |
破折号 | —— | – 、 — |
简体中文标点符号参考资源:
对于简体中文文档,请在中文和拉丁语系文字之间保留一个空格,但在拉丁语系文字和中文标点之间,则无需保留空格。
示例如下:
学习 Web 开发
学习Web开发
学习 JavaScript、HTML、CSS 等
学习 JavaScript、 HTML、 CSS 等
应用程序接口(API)
应用程序接口( API )
对于链接文字和非链接文字部分,同样适用此规则:
它指向一个[示例](#示例)
它指向一个 [示例](#示例)
指向 [MDN 开发者文档](https://developer.mozilla.org/)的链接
指向[MDN开发者文档](https://developer.mozilla.org/)的链接
请注意,数字与中文之间也请保留空格:
需 10 个小时完成
需10个小时完成
英文文档中,对于较长的段落,会通过断行的形式截断,以方便维护文档。但在 Markdown 中,断行会引入空格,在简体中文翻译中,我们有如下约定:
例如:
1 2 3 | This is an example. We usually write a paragraph into multiple lines. Like this. |
---|
而在中文文档中,应该使它们在同一行内:
1 | 这是一个示例。我们不应该断行写这一段话。就像这样。 |
---|
我们无需将“you”翻译为“您”,在文档正文部分的翻译中,请统一使用“你”。
英文文档中,为了使语句的语法正确,会使用大量的复数形式。在中文翻译中,则无需保留这些复数的形式(未翻译的英文名词也同理)。
Application Programming Interfaces (APIs)
应用程序接口(API)
应用程序接口(APIs)
应用程序接口们(APIs)
我们在仓库中维护了一个术语表,旨在统一目前还未有明确中文翻译的术语。在翻译文档时,请尽量使用术语表中的术语,以保证文档的一致性。
英文文档中使用了一些常见标题,为了保持简体中文文档的一致性,请在翻译时参考术语表中的标题和表格的翻译。