关于编写易于翻译的内容
请遵循以下指南,确保您创建的内容能够成功翻译。更多信息,请参阅“样式指南”。
- 使用通俗易懂的示例。
- 避免使用有争议或特定文化背景的示例。
- 使用主动语态。
- 使用简洁、简短、易于理解的句子。
- 避免使用过多可能使文本不清楚的代词。
- 避免使用俚语和笑话。
- 避免使用否定句。
- 尽可能使用行业标准缩写,并解释自定义缩写。
- 使用陈述语气。
- 避免冗余和冗长的表达。
- 避免过度使用堆叠修饰语(名词串)。译者可能会误解哪个名词是被修饰的。
- 避免不明确的复数,其中不清楚第一个名词是单数还是复数。
- 避免名词化。
- 避免使用含糊的情态助动词。
- 避免使用性别特指词。
- 避免使用介词短语。
- 避免使用含糊的名词和代词(含糊的句子主语)。
- 尽量减少内联链接。如果需要,请在前面加上诸如“更多信息,请参阅“链接标题”。或者,在主题末尾的“进一步阅读”部分添加相关链接。
示例
本节提供了如何遵循我们编写易于翻译文档的指南的示例。
避免使用特定国家/地区的信息
例如,避免使用 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)."