到世界各地的每个人都生

[jarinislamfatema]

使用被动语态时，主语受到动作（鲍勃跑了一场马拉松）。 您希望文档中的每个句子都尽可能清晰和简单。不要把事情复杂化，也不要让文档的读者费力去理解。 鼓励使用引人注目的标题 良好的文档应与编写任何类型的内容处于同一水平。您需要使用醒目的标题，以便读者确切地知道接下来的内容和预期内容。考虑活在大量内容之下，这一点尤其正确。

正因为如此，用户往往会比以前浏览得更多。当您使用醒目 建筑师数据库 的标题（和副标题）时，它会使内容更易于阅读和理解。 任何可以减轻那些依赖文档的人的负担的措施都应该被视为必须的。 告别流行语和缩略词 当你采用引人注目的标题时，一定要避免依赖流行语。这在技术领域尤其重要，因为并不是每个人都能理解每一个流行语和缩写词。 在编写文档时，重要的是要假设阅读文档的人不知道并且不了解当前的术语。

文档可以帮助其他人了解贵公司如何做和使用某些东西。如果您的开发人员过于依赖流行语和缩略语，那么无法保证阅读文档的人会理解他们所读的内容。 添加视觉效果 只要有可能，就将视觉效果添加到文档中。当您记录GUI 工具的工作原理时，这一点尤其重要。与其描述图形元素，不如展示图片。毕竟，人们说一张图片胜过千言万语，在文档领域，这句格言是正确的。