有句话说得好：好的代码需要文档来支撑。但是，你想要写出一份优秀的文档，又该怎样做呢？今天，我们就来谈谈一位软件开发界的大佬 – Jacob Kaplan-Moss，他是一位优秀的写手，被誉为文档撰写领域的权威。
可能已经有不少人听说过Python和Django——这两个世界级软件的创造者正是Jacob Kaplan-Moss。他还是一位专业的写手，相信很多程序员都会通过他的文档，入门Python和Django。今天，我们就来学学Jacob Kaplan-Moss的写作方法，让你的文档也能变得优秀起来。
一、了解你的读者
在写作过程中，了解读者的需求非常重要。不同的人群具有不同的需求，针对不同的需求，你需要制定针对性的文档。假如你的文档是面向初学者，那么你需要解释一些基础的概念，同时需要提供详细的步骤和截图；假如你的文档是面向专业人士，那么你可以简化一些操作过程，减少细节的展现。Jacob Kaplan-Moss一直很注重读者，他认为如果你写得太简单，会浪费读者的时间；如果你写得太复杂，读者又会跟不上。
二、保持想象和创造力
有时候，文档是会有生命的，而这是来源于你的想象力和创造力。比起单调的文字描述，使用图片、视频、演示文稿等多种形式展现内容会更吸引人，更容易理解。Jacob Kaplan-Moss在他的文档中经常使用图片和gif动画，这些形式不仅能很好地说明问题，而且更加生动有趣。
三、让结构简明清晰
什么样的文档会更容易被大家记住呢？一个简明清晰的结构可以让阅读体验更加简单顺畅。在写作文章或文档之前，应该先列出大纲。 Jacob Kaplan-Moss在著名的文档撰写系列文章中强调，文档结构应该是层叠的——一个清晰的结构会让读者保持专注，避免他们迷失在信息的海洋中。
四、再次审查至完美
写出文档并不是一次就能完成的，通过反复审查和修改可以让文档变得更加出色。在Jacob Kaplan-Moss的文章中，他推荐使用两种不同的审查方法：第一种是通过代码审查工具来查找笔误和拼写错误；第二种是通过让其他开发人员进行审查来查找更多的错误和漏洞。
总而言之，写作出色文档并不是一件容易的事情，需要一位有创造力、准确、专注的写手来实现。若想了解更多与文档撰写相关的内容，Jacob Kaplan-Moss的文档撰写系列是一份值得阅读的杰作（https://jacobian.org/series/great-documentation/）。若想写作出一份优秀的文档，以上的经验和建议可能会对你有所帮助。
了解更多有趣的事情：https://blog.ds3783.com/