在以前的项目里为了写作方便,总是以word文档的方式提供架构和设计文档,带来的好处仅仅是自己写作起来较为方便,但带来的麻烦却有很多,比如:
- 更新文档较为麻烦。
- 他人浏览较为麻烦,特别当需要从docx转换到doc的时候。
- 很难形成与其他文档的联系。
- 难以协同合作
以上的缺点导致很不好的后果:设计有了更新却懒于同步到文档里,他人也不愿看文档,干脆直接来问设计者,文档支凌破碎,写文档成了个别人的事情。因此在计费二期里我决定摈弃用word的形式,改成用wiki,并在公司wiki里好好规划起来,相比较word,wiki有以下好处:
- 完成基本格式文档很方便。
- 文档聚合和组织很方便,关键在于要善于用标记语言,可以参考:http://www.adaptavist.com/display/AtlassianConfluence/Macros
- 随时随地可以写文档和更新
- 随时随地可以查看文档
- 协同合作较为方便
几个优点马上带来了改观:
- 文档时效性明显提高
- 开发人员开始乐意写文档,写文档成了全民运动
- PD和测试人员乐意看文档,不再常常骚扰开发人员
- 文档组织井井有条,展现了项目开发的专业性
- 设计评审时一目了然,使得会议进行得顺利流畅
- 让项目过程有效记录下来,使合作更加清晰明了
从这个小事情上发现一个道理,干项目不仅需要执行力,还需要小技巧和不断改进,往往一些小小的改进,带来的好处会让你意想不到