如何自己编写像 google doc 一样的文档, 阅读 Google Writing Principle

基础部分

使用术语

1. 术语使用要保持前后一致
2. 缩略词第一次出现应为 Telekinetic Tactile Network (TTN) 形式
3. 使用术语全称还是缩略词需要考究.
4. 重用名词而不是使用代词.(就像指针一样, 代词往往会引入错误和歧义) This, That, It, Them

使用主动语态(谁对谁做了什么)

大多数人的思维方式是主动语态, 可以帮助读者跳过预处理器阶段,直接进行编译. 并且主动语态更短. 被动语态有时会省略 actor.

• 错误例子

消除句子歧义

使用准确的动词

The error occurs when clicking the Submit button.

<aside> 💡 Clicking the Submit button triggers the error.

</aside>

This error message happens when...

<aside> 💡 The system generates this error message when...

</aside>