|
没写过需要被人 review 的文档的人,不知道写文档有多难。
如果你代码写得好,自然是希望做事精益求精,那么写文档你可能也会尝试去尽量写的好,甚至某些情况需要反复迭代。
客观现实是:
1. 你有那个写文档的能力吗?文字能力需要经年累月的训练,和写代码一样。如果你没有坚持写文字,那么这是一件非常难做好的事情。写的不清不楚的文档,使用者看完还要反复来查代码,甚至找文档编撰者进行核对。
2. 你有那个写文档的时间吗?文字工作对文字工作者来说都是非常耗时间的,更何况是一个程序员?
3. 你写了文档,有人愿意读,有人愿意用,有人给你反馈吗?有的人可能文档是有 review 流程的,好歹会被人吊一遍。普通人在绝大部分公司里写的文档但凡有一个人能用到都得傻眼。
4. 有一个非常实际的问题,项目需求总是变化,要能及时追踪变更并同步去更新文档,这比从头开始写文档要更难。 |