现在的位置: 首页 > 综合 > 正文

写文档的碎碎念

2013年11月28日 ⁄ 综合 ⁄ 共 956字 ⁄ 字号 评论关闭

文档写完了,才稀里糊涂的明白是怎么回事。从开始的四天写一篇文档到两天写一篇,到现在一天可以写两篇。不知道是我要求过低,还是写文档真的很累人,反正现在我一天写完两篇文档感觉很累很累,大脑好像不转了一样。
看别人写文档也不是太累,可是我总觉得我写文档很纠结,特别的耗费时间。

 

需求文档
在写需求的时候开始不知道写什么,后来写了一大堆,可是后来又发现这不是需求有点像功能。

设计文档

在设计的时候,对于概要设计和详细设计又纠结了,不知道改写到什么程度。
写完概要设计后,明白了每个文档的编写目的都有一个预期的读者,才开始想读者的作用,文档的范围。
原来写文档最重要的是要知道文档是给谁看到,这样在下笔的时候就会有个衡量的尺寸。

 

画图
其次是画图,画图总是很慢。文档中很多地方需要用到图。开始慢慢的画基本图。画了有十几张,发现每一张图都是大同小异,把思想抽出来都一样,感觉放到哪里都合适。在懵懂了读者,功能和数据后,发现还是有侧重点的。

 

文档内容
有些东西写上没有任何意义,可以不写。开始时照葫芦画瓢,国标上有什么,我就写什么,有些就是生拼硬凑上的。

例如有的要求写开发工具:媒体文件。在做机房收费的时候,没有使用的什么辅助工具,很乖巧的我写了“没有使用辅助工具。”现在觉得我大可以把辅助工具,媒体文件这类的文档要求去掉。

 

用户手册和操作手册

最后写完操作手册发现还有用户手册,恩?不一样吗。斟酌了一把,发现还是不一样的。
1、  操作手册是用户手册的一部分。
2、  操作手册是系统级别的文档,而用户手册是需求级别的文档。操作手册讲述的是如何操作该系统的某个页面(你可以根据系统的菜单,一个一个的讲述它的操作按钮),而用户手册是在用户想做什么事情,在这样的前提下引导用户去操作该系统完成这样的需求(比如可以写个使用快速入门的小手册,把常规的使用写好:要实现什么功能要怎么操作)。
3、  在做项目的时候一个操作手册可以代替用户手册,功能需求很明确;
4、  用户手册不光要对系统操作说明,要从头开始的服务器配置,系统安装,系统操作,系统维护等等,完全是套成熟的流程模式,这样说来软件配置说明书也属于用户手册的一部分了。
它们的中心不一样。用户手册是一个全面的文档,从功能到操作,到配置,但是每一部分又不是很详细,具体到每一个环节还需要查看相关说明文档。

 

 

抱歉!评论已关闭.