Skip to content
On this page

文档

WARNING

该部分需要完善。

编写不同文档遵循着通用的原则。

尊重有限脑力

当人开始阅读时,他们从一定量的有限脑力开始。当他们用完这部分脑力时,他们就会停止学习。

复杂的句子、一次必须学习多个概念、不直接相关的抽象示例,都会更快地耗尽脑力。

使用短句、分解出可消化的部分、调整文档的顺序,能减缓脑力的消耗,使阅读者得以继续下去。

从阅读者角度出发

当我们彻底了解某件事情时,它才会变得很明显。

因此,为了写出好的文档,试着思考你在接收某部分信息时首先需要知道什么。你需要了解哪些专业术语?你误解过什么?什么东西花了很长时间才真正掌握?

好的文档本身就能满足阅读者的需要,而无需阅读者借助别的资料来理解它。

先描述问题,再描述解决方案

在展示一个功能如何工作之前,必须解释它为什么存在。否则,阅读者将没有背景,不知道这些信息对他们是否重要,也就失去了对这些信息的兴趣。

参考

Released under the MIT License.