跳至主要内容

撰写待翻译内容

我们的文档已被翻译成多种语言。我们在编写英文文档时的做法可以极大提升这些翻译的质量。

本文内容

关于编写易于翻译的内容

请使用以下指南,以确保您创建的内容能够成功翻译。欲了解更多信息,请参阅 风格指南

  • 使用通用且大多数人都能理解的示例。
  • 避免包含争议性或特定文化群体的示例。
  • 使用主动语态。
  • 编写简洁、短小且易于理解的句子。
  • 避免使用过多可能导致文本不清晰的代词。
  • 避免使用俚语和笑话。
  • 避免使用否定句。
  • 尽可能使用行业标准缩写,并对自定义缩写进行解释。
  • 使用陈述语气。
  • 消除冗余和冗长的表达。
  • 避免过度使用堆叠修饰语(名词串),翻译者可能会误解被修饰的名词。
  • 避免隐含复数,使人难以判断第一个名词是单数还是复数。
  • 避免名词化。
  • 避免使用含糊的情态助动词。
  • 避免使用性别特定的词语。
  • 避免使用介词短语。
  • 避免使用模糊的名词和代词(模糊的句子主语)。
  • 尽量减少行内链接。如有必要,可在前面加上类似“欲了解更多信息,请参阅‘链接标题’。”的短语。或者,将相关链接添加到主题末尾的“进一步阅读”部分。

示例

本节提供了遵循我们编写易于翻译文档指南的示例。

避免特定国家的信息

例如,避免使用 800 号码和特定国家的地址。如有必要,请注明信息适用于哪些国家。

避免过度使用堆叠修饰语(名词串)

大量堆叠修饰语可能导致翻译错误,因为难以判断修饰关系。例如,应使用“公共仓库的默认源设置”,而不是“公共仓库默认源设置”。

避免隐含复数

例如,使用“文件检索”时,无法判断是检索单个文件还是全部文件。请提供更多上下文以消除歧义。示例中,可使用“检索所有文件”或“检索 source.md 文件”。

避免名词化

例如,使用“得出结论”而不是“达成结论”。

避免使用含糊的情态助动词。

避免使用“may”“might”等词语。要更加明确,以消除歧义。

避免使用介词短语

与其写“尝试多次后”或“根据仓库日志”,不如直接表述。例如:“尝试三次后”。

避免使用模糊的名词和代词

模糊的名词和代词会导致读者不清楚指代的是谁或什么,尤其在翻译时更是问题。例如:“维护者和贡献者可以访问文件和评论。在拉取请求中他们对其进行更改。”在此句中,无法判断更改的是文件还是评论。如果代词似乎指代多个先行词,请重新措辞以明确先行词,或用名词替代代词,以消除歧义。

在可能的情况下,请按照我们的风格指南清晰地引入链接。例如,以下句子可以改写为

Read [more about OAuth2.](/apps/building-integrations/setting-up-and-registering-oauth-apps/) Note that OAuth2 tokens can be [acquired programmatically](/rest/reference/oauth-authorizations/#create-a-new-authorization), for applications that are not websites.

您可以改用此方式

OAuth2 tokens can be acquired programmatically for applications that are not websites. For more information, see [AUTOTITLE](apps/building-integrations/setting-up-and-registering-oauth-apps/) and [Create a new authorization](/rest/reference/oauth-authorizations/#create-a-new-authorization).
© . This site is unofficial and not affiliated with GitHub, Inc.