反驳不需要写文档的言论

有很多工程师都持有一个观点：“不用看(写)文档，文档都在代码里”，还有一部分人认为，文档容易过时，很难跟上代码的更新节奏，因而没有必要写文档。

• 接手业务的时候吐槽别人不写文档，交接业务的时候又觉得这东西无需解释，根本不需要文档。
• 对此，首先我个人认为涉及代码细节的部分确实没必要写文档，但是对于总体的设计和业务的变更是绝对需要写文档的。有些人觉得文档有过时问题，那是因为他们没有引入版本（ChangeLog）的概念，过时的文档本身就是业务历史的一部分，我在接手一个业务的时候，常常就需要这些历史信息来辅助理解。

什么算好的技术文档

• 好的技术文档 的核心是 敏捷 。一方面，好的的技术文档是高度可维护的并且经常维护
  的，比如新增了一些功能，文档的作者能够快速更新文档，文档的读者能及时获取更新；另一方面，好的技术文档是易理解 的，更详细来说要表述准确、结构清晰、排版美观、风格统一。

了解受众

• 在撰写交接文档前，先确定受众群体，比如是同事、上级、客户等，以便确定交接内容和语言风格

交接清单

• 将要交接的工作或项目列成清单，尽可能详细地描述每一项。除了任务名称外，还应包括责任人、重要截止日期、工作进度、相关文件等信息，确保不遗漏任何关键信息。

背景资料

• 为了让接手人可以更好地理解项目或工作的背景和重要性，提供一些背景资料和历史记录是必要的。这可以包括之前的会议记录、相关邮件、数据报告、文档地址等。

说明书

• 对于每个任务或项目，提供清晰明了的说明，包括具体步骤、所需资源、相关方面的联系人等。避免使用过于专业的术语，以免造成误解。

考虑特殊情况

• 在编写交接文档时，要考虑到可能出现的特殊情况，如紧急情况、技术故障等，又或者日常问题处理提供相应的应对方案。

撰写结构化

• 将交接文档组织成易于阅读和查找的结构，可以按照任务或项目进行分类，也可以按时间顺序排列。添加目录和页码使得接手人能够快速找到所需信息。

审核与更新

• 在完成交接文档后，务必进行审核，确保没有遗漏或错误信息。同时，在日常工作中，不断更新和完善交接文档，以保证其时效性和准确性。

和平愉快

职场中，离职是我们经常遇到的问题，而离职前的工作交接对我们许多人来说，也是司空见惯的事情。不过，有时看似走一走过场的工作交接，其实并不是那么简单，稍不注意就会给自己、给公司带来不同程度的麻烦，需要我们妥善地处理好，以免“节外生枝”。

• 离职前的工作交接，是一项工作流程，也是一次情商互动。
• 接收工作之人，既需要细心地查找解决工作交接时可能出现的疏漏的环节，也需要周全地与对方搞好人际关系，做到交接的是工作，融洽的是感情，一举两得，两全其美。