代码改变世界

有用的文档

2010-04-30 00:33  xiaosonl  阅读(348)  评论(0编辑  收藏  举报

我是个反文档主义者,最主要的原因是因为我很懒,其实是不会写。随着开发项目的越来越大,开始认识到有些文档是不得不写的:

一. 常规的有用文档

1. 记录需求的文档,一切之起源,比如Scrum中的Backlog

2. 记录跟踪BUG的文档或工具,这点重要性勿容质疑。

3. 描述高层次架构设计的文档,虽然面对面交流比文档要好,可是对于架构这种涉及关联复杂,跨时间性长的文档,是必需要用文档描述的,随着时间的推移,人的大脑很难记住并展现软件的架构全景。

4. 任务计划/进度文档,任务的安排和分工,可视化项目的进度。

二. 非常规的有用文档:

1. 商业计划书,如果你在创业想找风投,这个就是敲门砖。

2. 产品远景规划,描述产品在将来的一个期望发展,可以时时用以激励团队,保持对目标的清晰。

3. 约定文档,团队合作在于相互协作,保持一致。一份约定文档,可以以书面的形式警惕拘束大家。一般是好的实践或不允许的实践的约定。