中文技术文档是否有写作规范？

[zjsxwc]

因为英文文档普遍比中文更容易阅读和理解，

一方面每个英语单词都有长短区别很容易识别，而每个中文汉字等宽就在视觉上导致中文文档看起来就会累人，

另一方面是英文语法更清楚明了，使用 `whose` `that` `which` 等定语从句就能描述清楚事物，但中文普遍却只能用一个 `的` 字来形容事物，多个`的`在一起非常容易导致歧义，在语法上就天然不方便读者理解，

然后我看现在流行的中文网络小说是有写作规范的，也是成工业化工程化的，多个写手写一本商业小说也很正常，那么中文技术文档是否也有写作规范，能够避免歧义，也能方便读者理解的那种规范。

[zjsxwc]

是否可以借助文言文 `之` `乎` `者` `也` 等语法来解决目前 `白话文` 用于写技术文档时出现的 难以描述清楚事物，又在视觉上识别累人的 问题？

[zjsxwc]

同样的问题也出现在 “中文变量命名” 以及 “中文编程语言” 中

[coderluan]

多读点书就好了.

[cairnechen]

https://github.com/ruanyf/document-style-guide

[guyeu]

不管是中文还是英文，你想要简明易懂，就要避免从句。。。“使用 `whose` `that` `which` 等定语从句就能描述清楚事物”是个伪命题。

[whileFalse]

这跟中文文档没关系，这跟语文水平有关系。
别看多了英文文档就学着英文的语法写中文文档。

[zjsxwc]

@guyeu 我的意思是指多个简单句，多次嵌套定语从句确实也不利于理解，但还是比中文中多个`的`的方式清楚

[TingHaiJamiE]

技术文档能有什么歧义，能举个例子吗？难懂的是那些英文直译到中文的文档吧。

[skys215]

mazhuang.org/wiki/chinese-copywriting-guidelines/
中文文案排版指北（简体中文版）

[zjsxwc]

随便找个中文书籍的段落看看，就知道当今中文文档书籍写作质量有多么难以理解，语句不通

https://i.loli.net/2020/05/26/eHR3CgzDMUv1uhl.png


@whileFalse
@TingHaiJamiE
@coderluan

[balabalaguguji]

有技术文档工具，按照模板来就可以了： https://easydoc.xyz

https://i.loli.net/2020/05/26/Wsb8yvkPcUqZAiz.png

[chizuo]

@zjsxwc 英文水平还不咋地呢，就把母语中文忘了。先把中文学好吧。