当前位置: 代码迷 >> 开发方法 >> 写文档的一点感想 和大家分享解决思路
  详细解决方案

写文档的一点感想 和大家分享解决思路

热度:10275   发布时间:2013-02-26 00:00:00.0
写文档的一点感想 和大家分享
用了一周的时间,把机房管理系统的主要文档写完了,主要是写了四个文档;可行性研究报告,需求分析,概要设计,详细设计。写文档也不是一件容易活儿。我把我对软件文档的认识写出来。用问答的形式。


--------------------------------------------------------------------------------

 

1. 问,写文档到底是在写什么?

答:写文档到底在写什么。我说,我们在写思想。你怎么想的你就怎么写出来。写出来以后就不光是在想了,是一个具体的计划。一个实施的方法。很多时候,我们不愿意去写文档,不光是我们学生,包括那些专业的软件开发人员,有时候也看到他们不愿意去写文档,愿意去写代码。觉得写代码简单,噼里啪啦的就写完了。

其实这个不是说你不愿意写文档,是你不愿意去思考,因为思考是很费力气的。写文档同样是这样,你得周密的思考,因为你写的是一个纲,别人要按照你写的去做。写代码只是一个体力劳动。没有思考的权利。但是有一条法则是不变的“劳心者治人,劳力者治于人”。劳力还是劳心?由你选择。

  


--------------------------------------------------------------------------------
 


 

2:问,写文档有什么用?

这个问题我用一段对话来说明,不写文档的后果。

A,B,C三个人开发一个软件。

A:小B,你的那个用户名的变量定义的什么呀?我忘了,告诉我,我要用。

B:你连接数据库用的什么呀!我用的是字符串连接,你怎么用控件了?弄得我还得重新编写。

A:你的那个确定按钮,怎么没有啊?我这里有啊!

……

C(维护人员):你们那会儿那个地方都用到这个函数了?这个函数错了?我的改,好好想想啊?

A,想呀想 还是想不出来。这时候B已近离开了公司。找不到了。

 

大家说这样能编写出好的软件吗? 


--------------------------------------------------------------------------------
 


 

3:问?文档写完就没事儿了吗?如果我想改写完的文档,每次改完了在发给所有人,那么好几百人都天天没事就收邮件吧。可能收的晚了还和大家设计的不一样的了。

  答:不是的,任何事物都存在缺陷,文档也一样,写完以后,要在使用的过程中不断的改善,当然不能改一次发一次,这个就用到我们将来要用到的文档管理工具。

 

文档管理系统是一个专门对各类文档进行智能化管理的安全平台,在这个平台上,每一位用户都能获得在部门间和企业中跨越地理界限地创建、编辑、控制版本、共享、跟踪、审批、发布、封存和保护信息的功能。凭借这个开放的、可伸缩的、全面的以及基于标准的系统,企业能够拥有高质量的以及易用的工具,以有条理的方式来管理海量的信息。员工间的、业务伙伴间的和客户间的协作能得到极大的提高,企业疫能对信息和业务流程的完整性进行全面的控


本文来自CSDN博客,转载请标明出处:http://blog.csdn.net/lsh6688/archive/2010/09/23/5902250.aspx

------解决方案--------------------------------------------------------
我倒是不反感写文档,但是我们写的文档过于形式化了,其实在项目中倒是启不了多大的作用。能够安装文档去做,确实不容易。
------解决方案--------------------------------------------------------
探讨
用了一周的时间,把机房管理系统的主要文档写完了,主要是写了四个文档;可行性研究报告,需求分析,概要设计,详细设计。写文档也不是一件容易活儿。我把我对软件文档的认识写出来。用问答的形式。
……

------解决方案--------------------------------------------------------
探讨
……
我就是利用这个软件来练习一下写文档,是一个机房收费的系统软件

------解决方案--------------------------------------------------------
有些情况下,没有必要把简单的事情复杂化(项目规模比较小3个人月以下)

要让软件开发敏捷起来的话,要确实写一些能持续更新,有用的核心文档
而不是到项目后期遗留的一堆垃圾文档,看了反而会误导别人的文档

文档是知识传承的一个载体,如果有其他有效的方式可以进行知识传承的话就可以替代文档
但一些核心文档还是必须的,而且个人觉得,之所以项目组成员写出的文档有问题,是接受的文档制作培训不足,另外个人的语文及写作水平也是一种限制,国外优秀的程序员为什么能够著书立说,成为什么什么之父,这跟他们平时进行文档积累是分不开的

一家之言仅供参考

祝你成功~~
  相关解决方案