项目文档管理的一些想法

我个人比较倾向于敏捷的方式，不赞同大而全的文档，因为那样的文档书写起来浪费时间，维护起来更浪费时间，更可怕的是没有持续更新导致文档与实际项目偏差很大的文档。所以我认为文档就是应该少而精，必须确保文档的持续更新才有价值，具体的细节让代码去说，当然代码本身要写的可读性高。

今天和项目管理人员讨论了一下，我觉得分为如下几种情况：

1. 正规立项的项目：那个当然要安装立项你当时承诺的给文档。我建议是
1）如果有需求分析阶段，那必须要出一个文档来记录这段时间的工作；
2）架构设计文档是必须的，因为在代码中是很难直观看到整体的系统设计；
3）概要设计、详细设计什么的我都不知道是想干什么，如果是说代码的具体实现，那就到代码中去看，没必要维护这个文档；
4）测试文档：这个比较尴尬，这个应该是测试人员编写的，但是我们现在的情况是自己测试，那么有测试就要有记录，把测试的预期、测试的结果、测试的结论要写清楚就行了，格式可以不限；
5）数据库设计文档：我个人认为这个写文档完全没意义，在架构设计中把数据库表结构的关联关系说明即可，工程目录下的db目录里面必须有当前版本的建表语句，这样就足够了。
6）这个开发完的系统每次发布必须要有基线，release的版本要入库。

2. common下的公共模块或小系统：因为系统比较简单，所以可以简化一下。我建议是
1）要有简单的架构设计说明
2）要有简单的功能说明
3）要有使用说明，这个可以用测试类来代替，在使用说明上写一下看哪些测试类就可以了
4）这个开发完的模块需要有基线，并且要入库。
其中这三个说明都直接写在一个readme文件中就可以了，该文件放在工程的doc目录下，可以方便的查阅。

3. example下的示例系统：这个就是个简单的例子，没有完整的系统功能，所以文档方面同common要求即可，readme放在工程的doc目录下。这个系统只需有基线，不用入库走那么麻烦的流程。

以上系统都必须有changelog的说明文档，这个是能随包发布的，也可以非常清晰的看到历史改动以及版本变迁。写changelog我认为是一个非常好的习惯，不管有没有release note的管理。

本文转自passover 51CTO博客，原文链接：http://blog.51cto.com/passover/566377，如需转载请自行联系原作者

项目文档管理的一些想法相关推荐

知识管理≈内容管理≈文档管理≈项目文档管理
事情的起因有点偶然,阿杜和我聊起系统的时候,说我们的系统现在开发的还可以,就畅想了一下能否有一个桌面文档管理系统,问起原因,主要是感觉很多人不会管理自己的硬盘,不会管理自己的文档. 我听了也是感觉一振 ...
Mobox项目文档管理-项目经理必备工具
项目文档管理-项目经理必备工具项目文档管理是项目管理中非常重要而基础的一环,存在于项目的整个生命周期之中.如果一个项目缺乏文档管理,那么它也就不是一个规范.标准的项目.文档管理在项目开发中占有十分重 ...
【转】如何更好的进行项目文档管理
如何更好的进行项目文档管理在文档管理的过程中,需要把握住一些重要的原则和方法,这样可以让我们的文档真正达到我们预期的目的. 文档模板的管理面对各类纷繁复杂的文档,如果各式各样,每个人一个风格,不 ...
PM_14 项目文档管理与配置管理
选择 + 案例 1. 信息系统项目文档及其管理 1.1 信息系统项目相关信息(文档) 1.1.1 软件文档分类(三类) 1.开发文档描述开发过程本身(技术),基本的开发文档包括: (1)可行性研究报告 ...
php 项目管理,PHP开源项目:文档管理_php开源项目网
当前位置: php开源项目网 > 文档管理 > 开源项目:文档管理 XODA是一个采用PHP和Ajax开发的文档管理系统(DMS).无需用到数据库,支持为文件和目录添加备注说明信息和过滤功 ...
从项目交接看项目文档管理
FORM:北京华泰科信公司 http://www.huataiinfo.com/PMCenter/PMWH431.htm 项目文档对于项目管理的作用已经不用再讲了,但文档的管理却又通常是项目管理中最容 ...
showDoc项目文档管理工具
ShowDoc是什么每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂.文档呢?!文档呢?!Show me the doc !! 程序员都很希望别人能写技术文档,而自己却 ...
西南电力设计院之项目文档管理
一.客户背景西南电力设计院(以下简称西南院)成立于1961年6月,隶属中国能源建设集团中国电力工程顾问集团公司,综合实力雄厚,工程经验丰富,专家人才汇集,具有国家首批颁发的工程设计综合甲级资质,及电 ...
【酷玩集团】文档管理手册
A3_1 酷玩集团文档管理手册酷玩集团目录 1.文档管理者职责 2.文档说明 2.1文档编制标准和指南 2.2文档质量等级 2.3文档具体类型 3.文档修改记录规定 4.文档统一格式规定 5.文档 ...

项目文档管理的一些想法

项目文档管理的一些想法相关推荐

最新文章

热门文章