2024年最新#如何写好技术文档——来自Google十多年的文档经验(1)，2024年最新蚂蚁金服内推四面

最新推荐文章于 2024-10-02 23:04:10 发布

2401_84919661

最新推荐文章于 2024-10-02 23:04:10 发布

阅读量348

点赞数 4

文章标签： go 学习面试

本文链接：https://blog.csdn.net/2401_84919661/article/details/138889780

版权

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上Go语言开发知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

如果你需要这些资料，可以戳这里获取

		* [设计文档](#_79)
		* [引导类文档](#_93)
		* [概念性文档](#_99)
		* [Landing pages(落地页)](#Landing_pages_107)
	- [文档Review](#Review_113)
+ [写文档的哲学](#_123)
+ - [5W法则](#5W_127)
	- [三段式写作](#_137)
+ [结语](#_142)

已剪辑自: https://segmentfault.com/a/1190000040409082

本文大部分内容翻译总结自《Software Engineering at Google》第10章节 Documentation。另外，该书电子版近日已经可以免费下载了 https://abseil.io/resources/swe_at_google.2.pdf，有兴趣的同学可以下载翻阅下。首先声明，本问所说的文档不仅限于纯文本文档，还包含代码注释(注释也是一种特殊形式的文档)。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-M5RvcsSN-1662391785051)(https://segmentfault.com/img/bVcTIpw)]
很多技术人自己非常轻视技术文档的书写，然而又时常抱怨文档不完善、质量差、更新不及时…… 这种在程序猿间普遍存在的矛盾甚至已经演变成了一个段子。
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-qX3IHCtr-1662391785052)(https://segmentfault.com/img/bVcTIpx)]

文档的重要性

高质量的文档对于一个组织或团队来说有非常多的益处，比如让代码和API更容易理解、错误更少；让团队成员更专注于目标；也可以让一些手工操作更容易；另外如果有新成员加入的话有文档也会让他们更快融入……

写文档有比较严重的收益滞后性，不像测试，你跑一个测试case，它能立即告诉你是对还是错，它的价值马上就体现出来了。而写一份文档，随着时间的推移，它的价值才会逐渐体现出来。你可能只写一次文档，将来它会被阅读上百次、上千次，因为一份好的文档可以在未来替你向别人回答类似下面这些问题。

为什么当时是这么决策的？
为什么代码是这样实现的？
这个项目里都有哪些概念？
……

写文档同样对于写作者也有非常大的收益：

帮你构思规范化API： 写文档的过程也是你审视你API的过程，写文档时会让你思考你API设计是否合理，考虑是否周全。如果你没法用语言将API描述出来，那么说明你当前的API设计是不合理的。
文档也是代码的另一种展现： 比如你两年后回过头来看你写过的代码，如果有注释和文档，你可以很快速理解代码。
让你的代码看起来更专业： 我们都有个感觉，只要文档齐全的API都是设计良好的API，虽然这个感觉并不完全正确，但这两者确实是强相关的，所以在很多人眼里，文档的完善度也成为衡量一个产品专业度的指标。
避免被重复的问题打扰： 有些问题你只需要写在文档里，这样有人来问你的时候你就可以让他直接去看文档了，而不是又给他解释一遍。

为什么大多数人都不喜欢写文档？

关于文档的重要性，每个技术人或多或少都知道一些，但很多人还是没有写文档的习惯，为什么？除了上文中提到的文档的收益滞后性外，还有以下几点原因：

很多工程师习惯将写代码和写作割裂开，不仅仅是在工作上，而且在思想上就认为它们是完全不相关的两项工作，这就导致好多人重代码不重文档。
也有很多工程师认为自己不善写作，索性就不写了。这实际是个偷懒的借口，写文档不需要华丽的辞藻、生动的语言，你只需要将问题讲清楚即可。
有时候工具不好用也会影响的文档写作。如果没有一个很好的写作工具将写文档嵌入到开发工作流程中的话，写作确实会增加工作的负担。
大多数人将写文档看做是工作的额外负担。 我代码都没时间写，哪有时间写文档！，这其实是错误的观念，文档虽然前期有投入，但能让你代码的后期维护成本大幅降低，磨刀不误砍柴工这个道理相信大家都还是能理解的。

如何产出高质量文档

既然理解了好文档的重要性，我们如何保证在时间的长河中维护好一份文档，这里有些相关的方法论，大家可以参考下。

像管理代码一样管理文档

对于如何写出好代码，整个技术圈已经有好多经验的总结了，比如书籍《重构》《代码简洁之道》…… 针对各种编程语言，也有相关的规范，比如国外的Google C++规范，国内的阿里Java开发规范等…… 但对于文档似乎相关的资料却很少。但实际上，不应该把文档和代码割裂开来，你可以简单粗暴地认为文档其实就是用一种特殊语言书写的代码，这种语言就是人类的语言。这么想的话，实际上我们很多在代码和工程中总结出来的经验，也可以直接用在文档中，比如：

有统一的规范
有版本控制
有明确的责任人维护
有变更Review机制
有问题的反馈和更新机制
定期更新
有衡量的指标(比如准确性，时效性)

明确你的读者是谁

写文档有一个很常见的错误，那就是很多人文档都是写给自己看的，这种情况下就会导致你的文档只有自己或者和你有相似知识背景的人才能看懂，团队较小时这种问题还好，你们都做着类似的工作，所以也都能看懂文档。但当团队逐渐壮大后，问题就会凸显出来，新人有时候有着和你不同的工作背景，甚至现在都做着不同的工作内容，这时候你之前写的文档他们就很难读懂了。

所以在写文档之前请明确你文档可能的读者会是哪些人，然后针对他们的特点着重关注如何才能让他们理解。当然，文档也不一定要非常严肃和完美，只要能向你潜在的读者说明问题即可。记住文档是写给别人看的，不是给自己看的。

根据专业水平可以大致将读者分为三种新手、老手和专家，针对不同水平的人写作需要有侧重点。比如针对新手，你需要重点介绍下里面涉及到的术语和概念，然后详细讲解具体的的实现。相反，针对专家你可以省去这些额外的信息。注意，这里没有严格的标准，因为有些文章新手会看，专家也会看，这里还是需要具体情况具体分析。

另外一种对读者分类的方式就是根据读者阅读文档的目的来分类，比如有人知道自己遇到了什么问题，就是来找解决方案的。还有一批人只有一个简单的想法，但不知道具体的问题。举个例子，以读数据库慢为例，前者已经知道数据库慢可能是因为数据量巨大且没有加索引，解决方案很简单加索引，这时候他可能需要知道的是如何正确地加索引。而后者可能着重关注的是为什么读数据库会慢，这时候你可能需要额外重点介绍下数据库相关的原理。

清晰的分类

文档大致可以分为以下几种类型，每种类型也有自己不同的特点和写作侧重点。

参考文档

参考文档也是大部分开发人员日常会使用和书写的文档，比如我们使用某个框架或者工具，都会有API说明文档，这就属于参考类文档。它并没有太多的要求，只要能向读者展示清楚如何使用即可，但无需向读者讲明具体的实现。

注：参考文档并不仅限于API文档，还包括文件注释、类注释、方法注释，要求都是能准确说明其用法。

设计文档

很多公司或者团队在项目开始前都要求有设计文档，设计是项目实施的第一步，所以在设计文档书写的过程中要求尽可能考虑周全，例如该项目的存储、交互、隐私……

好的设计文档应该包含以下几个部分：

设计目标
实现的策略
各种利弊权衡和具体决策
替代方案
各种方案的优缺点

写设计文档的过程也你对整个项目做规划、思考可能出现问题的过程，设计的越详细、思考的越多，未来遇到问题的可能性就会越小。

引导类文档

引导类文档也很常见，一般都是Step by Step的形式。比如我们在使用某个框架或者工具的时候，一般都会有个引导类的文档一步一步帮助你快速上手。大家写引导类文章大家非常容易犯的一个错误就是预设了很多背景知识。一般使用文档都是有开发者写的，他们都非常了解这个工具的相关的知识，所以习惯性的会认为，啊这个知识点很简单用户也肯定会吧，实际上用户不一定会。这本质上就是一种认知偏差，这种现象在跨团队协作尤其是多端协作的时候也非常明显。

这类型的文档写作中，要求写作者尽可能站在用户的视角上思考，极力避免出现和用户的认知偏差，力争每个步骤做到明确无歧义，每两个步骤之间做到紧密衔接。