公司的文档水平一向不好，习惯也很不好。在代码中能写个注释，已经算是有好习惯了。在我看来最低限度的ReleaseNotes，都是有人去推动后才建立起来的制度。大言不惭一下：看起来正式一点的文档，大多出自我的手笔。
前段日子，下了狠心，盯着同事们整理了一篇文档。大约三、四个月的开发内容，最后写了82页。我觉得不算多，但可能已经多得让不少人懒得去看了。也正常，文档不是小说，不是让你没事从头翻到尾的。有需要的时候去查上一查，还能有所收获，这就已经算是有价值的文档了。尽管离我认为的「先写文档后编码」还有不少差距，但要是能事后真真正正地补上，也是功德一件。
现在流行AI，公司上上下下都在搞自己部门的RAG。这推动了一波文档热潮。AI没有东西吃，吐出来的东西也就质量不咋地。这样一来，文档就愈发的重要了。
对我而言，这是好事。我倒是喜欢写文档。比起写代码，写文档更接近我的舒适区。何况偶尔我也会塞点「私货」进去，甚至把文档写得像小说一样。反正是内部文档，调皮一下也无妨。将来万一有人看到，也许会有会心一笑。
而且，为了能安心退休，我倒是也愿意把自己的「毕生所学」给「贡献」出来。知识这种东西，有的人会藏私，但我觉得藏着掖着没意思。真正的能力，并不在于别人学不到的东西，而是别人学不会的东西。
有的时候，有些文档会让人觉得很没意思。完全是形式主义，没有什么有价值的内容。对这种文档，我个人是并不喜欢的，但偶尔也必须得去做一做，还好不是太多。
在现在的公司，基本碰不到这种事情。就算有，可能也不是我的事情。但在以前的公司，就会有不少。看起来厚厚的一叠文档，比词典还厚。有没有人看？没有。有没有用？有。你得有它。有就行。
曾经向当时的主管抱怨过，得到的回答是：这些文档的确没有意义，但规定要求必须得有它们。可能是因为如果能沉住气把这些都完成了，那这个项目的总体质量应该也不会差到哪里去。
也就是说，这是甲方的一个测试，一个考验，或者说是一个保证下限的东西。肯把这些无聊的事情搞完的，大概率也就不那么草台班子了。
或许有几分道理，也或许其实是歪理。但不管怎么说，总之当时的我是被说服了，埋下头继续写。
又有的时候，有些文档，真的是必不可少的。
记得以前说过这个观点，可能是在Google+上。我认为如果要自杀，一定要写遗书。悄咪咪地去死也就算了，别给后人留悬案。如果有遗书，家人或许还可以帮你讨个公道，没有遗书的话，很多时候就白死了。反正都是要死了，干嘛不把后事办好一点呢？
 |
| 图片来自网络 |
反正车费你都拿不回来。
没有评论:
发表评论