关于项目文档和wiki页面

(这里说的是不是产品文档,不是使用手册,而是干活的人用到的设计文档)


最近为项目忙得焦头烂额,根本没时间维护先前写的项目文档和wiki页面。放假了,利用空闲时间重新审视了一下那些文档,有以下发现:

  1. 先前写文档的自己和现在忙的焦头烂额的自己,判若两人。它写得未必多专业,但看着不像自己写的,那么多详细的表格、流程图、流程分析、相关模块的说明,以及对某个问题的多个解决方案的利弊分析,根本不像一个疲于奔命的人写出来的!
  2. 写wiki页面真的是有必要。先前项目刚接手的时候,US leader让我为项目创建一个wiki,心想这是形式主义,但不得不照着Boss的精神创建一个项目wiki页面。随着项目的进行,发生了很多事情,包括新增功能、security fix、knowledge transfer、bug fix等,这些都需要在一个统一的地方做记录,要不然以后会一盘散沙。每个改动我都放到了wiki页面上,现在看来,没有发生一盘散沙的情况,整体还算可控;真心感谢US leader当初的建议。


关于写文档的一些个人感想,总结如下:

  1. 写code之前先写点文档,非常必要,磨刀不耽误砍柴工夫。文档帮助自己整理思路,帮助别人更好地理解项目。也为以后的自己做备忘录,好记性不如烂笔头。
  2. 和项目相关的任何信息都可以而且建议加入文档
  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值