项目文档怎么写

January 13, 2019
项目文档 流程图

字数:2055

引言

看到了一个历史项目的八股文,又联系到我们平时用于项目沟通的文档,想到很多。 焦点问题就是:写一些什么东西才能准确地反映系统,又能很好地让人看明白。此篇并没有提出解决问题的准确答案,也许这个问题一直在路上。

1 八股文

看到国家图书馆的一个门禁系统的项目,大概是09年前后开发,项目开发相关人员大概4人,需求感觉是比较简单的:

从需求看,真的是比较简单的几个接口的事,而这个系统最终做成什么样?大概看了一下,测试用例就拆成有300个左右。项目文档给人的感觉也是大气磅礴:

综合来看就是,感觉这些文档不是给人看的:-(。不过不管是正面的还是反面的,总会给人以启示,比如为什么需要这些文档,这些文档达到了 价值的初衷了吗?还能怎么写,比如哪些地方可以人性化、实效一点,等等。

2 现在的项目文档

现在项目的文档,其实也是有问题的。先列一下,都有一些什么文档吧:

3 文档做什么用

这章来综合一下,我们为什么写这些文档。显然,写文档不是为了好玩,也不是为了好看,是实际的需要。 下面是我个人理解,我觉得这些时候都需要文档,也给这种文档定义了一个名称,当然这种名称与传统的说法是有出入的:

目前觉得有一些明摆着的问题:


loading