Mrzyxing commented on code in PR #548:
URL: https://github.com/apache/flink-web/pull/548#discussion_r895002820
##########
contributing/docs-style.zh.md:
##########
@@ -1,131 +1,82 @@
---
-title: "Documentation Style Guide"
+title: "文档样式指南"
---
-This guide provides an overview of the essential style guidelines for writing
-and contributing to the Flink documentation. It's meant to support your
-contribution journey in the greater community effort to improve and extend
-existing documentation — and help make it more **accessible**, **consistent**
-and **inclusive**.
+本指南概述了在编辑以及贡献 Flink 文档中必要的样式原则。目的是在你的贡献之旅中可以投入更好的社区精力去改进和扩展既有文档，并使其更 **易读**、
**一致** 和 **全面**。
{% toc %}
-## Language
+## 语言
-The Flink documentation is maintained in **US English** and **Chinese** — when
-extending or updating the documentation, both versions should be addressed in
-one pull request. If you are not familiar with the Chinese language, make sure
-that your contribution is complemented by these additional steps:
+Flink 同时维护了 **英语** 和 **中文** 两种文档，当你拓展或者更新文档时，需要在 pull request
中包含两种语言版本。如果你不熟悉中文，确保本次贡献补充了如下额外操作：
-* Open a
-
[JIRA](https://issues.apache.org/jira/projects/FLINK/issues/FLINK-12070?filter=allopenissues)
- ticket for the translation, tagged with the chinese-translation component;
-* Link the ticket to the original contribution JIRA ticket.
+* 开一个翻译的
[JIRA](https://issues.apache.org/jira/projects/FLINK/issues/FLINK-12070?filter=allopenissues)
票据，并打上 chinese-translation 的标签；
+* 在此票据上添加到原始 JIRA 票据的链接。
-Looking for style guides to contribute with translating existing documentation
-to Chinese? Go ahead and consult [this translation
-specification](https://cwiki.apache.org/confluence/display/FLINK/Flink+Translation+Specifications).
+正在寻求有助于将现有文档翻译成中文的风格指南？请继续查阅
[这个翻译规范](https://cwiki.apache.org/confluence/display/FLINK/Flink+Translation+Specifications)。
-[Back to top](#top)
+[回到顶部](#top)
-## Language Style
+## 语言风格
-Below, you find some basic guidelines that can help ensure readability and
-accessibility in your writing. For a deeper and more complete dive into
-language style, also refer to the [General Guiding
-Principles](#general-guiding-principles).
+如下，你可以看到一些初步的原则，这些原则可以确保书写中的可读性和通俗易懂。如果想更深入、更细致的了解语言风格，也可以参考
[通用准则](#general-guiding-principles)。
-### Voice and Tone
+### 语态和语气
-* **Use active voice.** [Active
-
voice](https://medium.com/@DaphneWatson/technical-writing-active-vs-passive-voice-485dfaa4e498)
- supports brevity and makes content more engaging. If you add _by zombies_
- after the verb in a sentence and it still makes sense, you are using the
- passive voice.
+*
**使用主动语态。**[主动语态](https://medium.com/@DaphneWatson/technical-writing-active-vs-passive-voice-485dfaa4e498)简洁，并让内容更具有吸引力。如果你在句子的动词后添加
_by zombies_ 后仍然读的通，那么你用的就是被动语态。
Review Comment:
- 主体是英文还是中文
这里当时也纠结过。
当时的想法是主体应该是英文：即这个文档规范主要约束的应该是写英文文档（而相对于汉藏语系，被动语态的确也是英语语系用的多），因为中文应该都是翻译过来的。
而翻译的语态问题在前面的一个翻译建议的 cwiki 链接中明确了，所以这里就没怎么动了。
- 按照中文描述
而中文的被动语态，试了几个，文中的鉴别方法应该也是适用的，不过要根据中文调整为：在动词前加“被”后也能语句通畅。
同时英文文档中例子也可以直接用，所以也可以这样：
```
*
**使用主动语态。**[主动语态](https://medium.com/@DaphneWatson/technical-writing-active-vs-passive-voice-485dfaa4e498)简洁，并让内容更具有吸引力。如果你在句子的动词前添加
_被僵尸_ 后仍然读的通，那么就是被动语态。
<div class="alert alert-info">
<b>主动语态</b>
<p>"你可以在 IDE 或者命令行中运行这个例子。"</p>
<p></p>
<b>被动语态</b>
<p>"这个例子可以在 IDE 或者命令行中（被僵尸）运行。"</p>
</div>
```
--
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]
