跳至主要内容

编写要翻译的内容

我们的文档被翻译成多种语言。我们如何编写英文文档可以极大地提高这些翻译的质量。

关于编写易于翻译的内容

请遵循以下指南,以确保您创建的内容能够成功翻译。更多信息,请参见 "样式指南”。

  • 使用通俗易懂的通用示例。
  • 避免使用有争议性或特定文化群体相关的示例。
  • 使用主动语态。
  • 使用简洁、简短且易于理解的句子。
  • 避免使用过多代词,以免造成文本理解不清。
  • 避免使用俚语和笑话。
  • 避免使用否定句。
  • 尽可能使用行业标准缩略语,并解释自定义缩略语。
  • 使用陈述语气。
  • 消除冗余和啰嗦的表达。
  • 避免过度使用堆叠修饰语(名词串)。翻译人员可能会误解哪个名词被修饰。
  • 避免使用隐形复数,即不清楚第一个名词是单数还是复数。
  • 避免名词化。
  • 避免使用模棱两可的助动词。
  • 避免使用性别歧视词语。
  • 避免使用介词短语。
  • 避免使用模糊的名词和代词(模糊的句子主语)。
  • 将内联链接数量控制在最低限度。如果需要,请在链接之前加上短语,例如“更多信息,请参见“链接标题”。或者,在主题末尾添加相关链接到“进一步阅读”部分。

示例

本节提供了一些示例,说明如何遵循我们关于编写翻译友好文档的指南。

避免使用特定国家的信息

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

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

大量堆叠修饰语会导致翻译错误,因为很难确定哪个词修饰哪个词。例如,使用“公共仓库的默认源设置”而不是“公共仓库默认源设置”。

避免使用隐形复数

例如,使用“文件检索”时,不清楚是指检索一个文件还是所有文件。提供更多上下文以消除歧义。在给定的示例中,您可以使用“检索所有文件”或“检索 source.md 文件”。

避免名词化

例如,不要使用“得出结论”,而应该使用“得出结论”。

避免使用模棱两可的助动词。

避免使用“可能”和“也许”等词语。要更清晰,避免歧义。

避免使用介词短语

不要写“尝试多次”或“根据仓库日志”,而应该更直接地写。例如,“尝试三次”。

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

模糊的名词和代词会使你所指代的人或事物不清楚,尤其是在需要翻译内容时。例如,“维护者和贡献者可以访问文件和评论。在拉取请求中,他们对其进行了更改。”在这句话中,不清楚更改是针对文件还是评论。如果代词似乎指代多个先行词,要么改写句子以使先行词明确,要么用名词替换代词以消除歧义。

尽可能地按照我们的风格指南清晰地介绍链接。例如,不要使用以下句子

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 "[Setting up and registering OAuth Apps](apps/building-integrations/setting-up-and-registering-oauth-apps/)" and "[Create a new authorization](/rest/reference/oauth-authorizations/#create-a-new-authorization)."