个人思考Category

引言 博主在工作中发现一个有意思的矛盾现象：每个人都同意把文档写好非常重要，但似乎大部分人都比较抗拒去写文档，或者写的文档比较敷衍，缺少很多关键信息。 注意，这里的“文档”指的不是像博客一样的文章，而是工作中用到的如技术方案、工作计划、复盘总结之类的材料，主要用来方便跟同事或者上级沟通，或留下记录。 这是不是让你想起了一句程序员间流传的老话：我讨厌两种人，一种是不写注释的人，一种是让我写注释的人。 本人还算写了不少文档，也积累了一定的经验，这篇文章主要是分享一些自己在工作中写文档的感悟，是一篇杂谈，而不是怎么写文档的方法论，文章的内容包括但不限于： 分析为什么写好文档很重要，但大部分人都不喜欢写文档 引申——如何驱动自己，培养做事情的习惯 一些关于写文档的小tips 正文 写好文档真的重要吗 先说结论：不一定，需要结合当下情况与长期考虑。 不知道各位有没有遇到过这样的情况： 场景一：接手了公司的某个项目，一看相关文档简直一团乱麻，想要知道项目信息（比如某个功能点的需求背景）需要在多个文档间反复横跳，甚至可能根本找不到信息，只能去找之前的负责人问，然后被各种“踢皮球” 场景二：接手了某个离职同事的项目代码，发现在经过了n轮测试迭代之后，原先的技术方案跟代码逻辑可以说毫无关系，代码也基本没有注释，只能硬着头皮搞“逆向工程”理清逻辑，进而导致项目的新任务延期 看了上面的场景，相信各位也意识到为什么需要写好文档了，个人认为重要性主要体现在以下几点： 知识留存与传承，缩短上手周期 提升协作效率，减少沟通摩擦 保证信息的可追溯性 但在场景二中，我们也能发现一个问题：过时的文档有可能是无用的。 那么，写文档解决了什么问题？它的本质是什么？ 我自己的理解是——文档的本质是投入前期的时间成本，减少后期的时间成本，前期投入的文档写作时间，会在未来的协作、维护和扩展中节约成倍的时间。 说到这里，上面的结论就很好理解了，写好文档确实是重要的，但需要考虑文档在未来的工作中能不能起到减少时间成本的作用。 文档困境 鲁迅曾经说过：写一篇好的文档看似困难，实际上并不简单 那么写文档到底难在哪呢，个人的感受如下： 将复杂的概念和流程清晰地表达出来，对许多人来说是一个不小的挑战，需要投入大量时间来理清逻辑 许多人在技术上很强，但可能缺乏编写文档的技能和经验，导致不知道该写什么，或者写不出重点 编写文档通常需要投入大量时间和精力，但往往与其他更紧急的任务发生冲突 可以发现，除了最后一点之外，其他的都是经验问题，那么解决方法就也明确了：多写，积累经验 此时可能你已经想到了这个经典表情包： 接下来，就是关于写文档的终极问题：怎么才能做到多写？ 试着驱动自己 微习惯 & 内在驱动力 可能有朋友已经发现了，不仅仅是写文档，大部分事情想做好其实都需要我们多做，培养习惯，然后熟能生巧。 那么具体该怎么做呢？ 这里博主推荐两本书：《微习惯》 和 《内在驱动力》。 简单介绍下概念： 微习惯：指一些非常小、简单到几乎无法拒绝的行为习惯，核心思想是通过设定微小的、容易完成的目标，逐步培养长期的积极习惯，从而实现持续的行为改变 内在驱动力：指个体由于内在的兴趣、享受或满足感而自发进行某种活动的动力，而不是因为外部的奖励或压力。内在驱动力源于个体对活动本身的热爱、好奇心和挑战感，表现为在没有外部奖励的情况下仍然愿意花时间和精力去完成某项任务 这里还有一个概念叫做“内化（Internalization）”，在心理学和行为科学中，指的是将外在的行为、规则或价值观转化为个体内在的、自发的需求或认同的过程。在养成习惯的语境下，“内化期”意味着让行为从“刻意坚持”转变为“自然需求”，甚至成为自我身份的一部分 一个示例 结合上面这的概念，以培养写博客的习惯为例，这里给出一个示例，各位可以参考： 首先，将写博客这件事分为三个时期： 启动期——用微习惯降低刚开始的阻力 适应期——寻找内在价值 内化期——依赖内在驱动力… Continue Reading 杂谈——关于写文档的个人感悟