SylviaBABY commented on code in PR #1105: URL: https://github.com/apache/apisix-website/pull/1105#discussion_r879410301
########## website/i18n/zh/docusaurus-plugin-content-docs/current/documentation-guide.md: ########## @@ -15,26 +15,29 @@ description: Apache APISIX 中文文档的贡献指南，适用于 APISIX 中文 ## 语气、内容和受众 -- 以友好和尊重语气为目标，尽量避免强硬的词汇。例如：“你必须”，“你一定要”。该类词汇可换成：“你需要”或着直接用“用户需要”等统称。。 +- 以友好和尊重语气为目标，尽量避免强硬的词汇。例如：“你必须”，“你一定要”。该类词汇可换成：“你需要”或着直接用“用户需要”等统称。 - 确定文档的受众以及文档的目的，为你和你的目标受众找到共同点，然后进行写作。 - 避免口语化描述，不使用冷僻、生造的词汇、不使用行业黑话或互联网词汇。例如：打满。 - 不使用具有歧义的词汇。例如：“小白”，可更换为“初学者”。 -- 文档中第一次出现英语词汇或者名词缩写时，应当给出全称及中文解释。例如：Apache APISIX 从底层架构来看，分为 数据面（Data Plane，简称 DP）和控制面（Control Plane，简称 CP）。 +- 文档中第一次出现英语词汇或者名词缩写时，应当给出全称及中文解释。例如：Apache APISIX 从底层架构来看，分为数据面（Data Plane，简称 DP）和控制面（Control Plane，简称 CP）。 ## 语言 - 写作时请尽量使用第二人称，如果不适用第二人称可统一替换为统称——用户或使用者。 -- 写作时使用主动语态。 +- 写作时使用主动语态，不要使用被动语态。 +- 如果是英译中的文档，需要符合中文阅读习惯，并确保句子通顺，无语病。 Review Comment: ```suggestion - 如果是英译中的文档，需要符合中文阅读习惯，并确保句子通顺，无语病。请注意，如果有些内容翻译过来没有必要或者表达无意义，请自行判断并进行调整或删改。纯机翻没有意义，文档要做的目的是给予阅读者清晰明确的指引，而不是毫无意义的文字。 ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
