`
lu930124
  • 浏览: 27989 次
  • 性别: Icon_minigender_2
  • 来自: 廊坊
文章分类
社区版块
存档分类
最新评论

文档编写那些可能你不知道的事

 
阅读更多
对于文档的编写,你了解多少呢?下面描述了一些我不知道的问题,看看你知道吗?

(一)总体来说,每一个文档在目录和引言之间,都要有一个变更记录表,当然,变更记录表的形式不固定,可以自己设计,但是主要的几项不能丢掉,如修改记录,变更时间,修改人,验收人等。在文档的编写时,你的文档标题是“****系统设计文档吗”?还是只是把文档的名称写上,没有放系统的名称。

(二)每一个文档中,都会出现一些问题,就我的问题,分析如下:

1、可行性研究报告

可行性研究报告由项目组长编写,给项目经理和boss看,所以预期读者是项目经理和boss。可行性研究报告,顾名思义,它是想分析一下,这个项目是否可行,话句话说,就是老板和项目经理看到这份报告后,确定这个项目要不要做!所以,这个项目的精髓就在于分析要开发的系统的经济可行性,技术可行性,社会因素可行性。编写目的自然是全方位分析这个系统,在现在的条件下,是否能够开发,开发时间,开发的预计资金。对于这个文档,你有没有丢掉三个重要的可行性分析呢?

2、项目开发计划

项目开发计划由项目组长编写,预期读者是开发小组,项目经理,boss以及客户。开发小组看项目开发计划,可以通过甘特图看到项目具体开发安排,项目经理和boss通过开发计划,可以大概得评估项目的价值,和项目开发安排是否合理,客户通过项目开发计划,可以确认项目是否符合自己的要求,以及是否需要更改。简单的理解,项目开发计划主要就是甘特图(我理解为“具体描述这个项目的所有工作安排即什么时间,什么地点,所有小组人员在做什么”)。项目开发计划中要写明非移交产品,如:可行性分析报告、项目开发计划书、软件需求说明书、概要设计书、详细设计说明书、测试计划、测试分析报告、开发进度月报、项目开发总结报告以及源代码等。

3、软件需求说明书

软件需求说明书预期读者为开发人员和用户。通过需求说明书,客户描述出自己对系统的要求,和预期系统的功能,系统开发人员通过需求说明书了解系统的大概模型和系统要实现的功能。软件需求说明书主要用于开发人员和客户沟通,形成纸质文件,在系统验收时提供凭证。需求说明书中主要的部分是对输入和预期输出的描写,也就是IPO图。通过预期的输入、处理、输出的这个图,描述出系统需要实现的绝大多数功能。

4、概要设计说明书

预期读者为开发人员、项目经理、验收维护人员、客户。概要设计说明书交给各个被调研单位审核,并经领导层讨论通过后,软件开发小组成员将以这本说明书为框架开发新的系统。在概要设计说明书中,可以用系统原型(可以设计系统原型,也可以把旧系统直接作为系统原型)直观的介绍系统功能,数据库(数据库中的表名、触发器、命名规范等),模块以及功能块等。在后期,可以把类图、包图放到概要设计说明书中。概要设计可以参考需求说明书和数据库设计说明书来写。对于概要设计中的数据库设计,可以简写。概要设计中应该写明系统期望实现什么、系统的出粗处理、补救措施和简单的维护计划。

5、详细设计说明书

详细设计说明书预期读者为开发人员、项目经理、验收维护人员。主要定义类、方法、参数注释(头注释、单行注释、多行注释、模块注释等。要以实际设计说明)、命名规范、详细类图等。举个注释的例子:

'头注释:***************************
        '**设计者:—
        '**设计时间:----年--月--日
        '**项目名称:
        '**审核人:
        '**修改人:
        '**修改时间:
		'**补充说明:
       '***************************
'单行注释:注释内容
'多行注释:代码功能,出错处理,等其他注释内容
'模块注释:*****************************
       	 '**模块名称:
  		 '**模块功能:
		 '**创建时间:
         '**创建人:
         '**更改人:时间
         '**模块说明
         '*****************************

在详细设计中,所有的约定都要做好,例如编码规则,这样,开发小组的各个成员才能按照规定,分别编写自己的部分,在最后把所有的工作合到一起的时候,才能在一定程度上保证系统可以使用。

6、数据库设计说明书

数据库设计主要是给系统开发人员看的。在数据库设计中,主要从物理设计,逻辑设计和结构设计三个方面来描述数据。使用ER图来描述数据库设计。对于数据库中的表,尽量用手写表,不要截图,写明数据库中表的命名规范和数据库中的约定。写明数据库存储过程,若出现图类的总结,在图的下面要详细的描述图中出现的数据。

7、测试计划

测试计划的预期读者为测试人员和客户,为做好集成测试和验收测试,需为如何组织测试制定实施计划,计划应包括测试内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。测试计划中要包含测试用例。

8、测试分析报告

测试分析报告主要是给软件开发者看的,测试分析报告是在测试分析的基础上,对测试结果以及测试数据等加以记录和分析总结。它也是测试过程中的一个重要环节,同时,它也是对软件性能的一个总的分析和认可及对不足之处的说明。

9、用户手册

用户手册主要是给用户看的,用户是在不了解这个系统的内部结构,不知到系统的功能的前提下,使用的用户手册。用户手册主要告诉用户该如何操作这个系统,可以截图说明系统如何使用。截图上一定要有相应的操作说明的文字,方便用户理解。

对于文档编写,这些都是我的一些个人想法,如果出现错误,欢迎评论指出,感激不尽!

分享到:
评论

相关推荐

    编写程序高手的造就的文章

    知道很多低手不知道的事。玩过很多低手听都没听过的东西。  要靠自己,努力满足客户的各种需求。个人技能是在满足客户的各种需求的过程中提高的。比如你喜欢用delphi,客户说一定要用vb,那你就答应他,然后把...

    [原创]串行数据接收器代码,经过综合和简单的仿真

    根据一网友的文档编写了一个简单的串行数据接收器,经过综合和简单的仿真,没有发现功能错误,希望大家指正,文档和代码都在压缩文件中。因为自己也是新手,所以有以下问题: 1:我对从线路中提取时钟的方法不熟悉,...

    Word_2007多级列表一用就会

    然而绝大多数使用Microsoft Office的朋友却并不知道Word有这么个工具;或者即使知道,却对如何正确使用这个工具不得要领。有的人可能会用“标题一”样式来做单级列表,但是在碰到需要二级列表甚至三级列表的时候,却...

    你必须知道的495个C语言问题

    3.12 我不想学习那些复杂的规则,怎样才能避免这些未定义的求值顺序问题呢? 其他的表达式问题 *3.13 ++i和i++有什么区别? 3.14 如果我不使用表达式的值,那我应该用i++还是++i来做自增呢? 3.15 我要检查...

    perl语言脚本文档说明

    1.3 编写你的第一个Perl程序 9 1.3.1 键入程序 9 1.3.2 运行程序 9 1.3.3 程序正确将会发生什么情况 10 1.3.4 Perl程序的具体运行过程 10 1.3.5 必须知道的一些情况 11 1.4 课时小结 12 1.5 课外作业 12 ...

    使用NUnit在.Net编程中进行单元测试

    幸好我们现在就有一件在程序员看来非常普通的任务: 你今天第一天上班,你的项目经理拿给你一叠不算厚的文档,告诉你今天的任务是按照文档中的要求编写一个.Net类,可能因为任务并不复杂,所以他看上去非常的随意。...

    c语言和设计模式技术文档

    关于软件设计方面的书很多,比如《重构》,比如《设计模式》。至于软件开发方式,那就更多了,什么极限编程、精益方法、敏捷方法。随着时间的推移,很多的方法又会被重新提出来。...如果用C++语言,你可能会这么写。

    单片机课件(超经典).rar

    即使是开始了专门的单片机课程,但是课程的内容与技术文档很相识,指令很多,但是完整的不多,所以学完了也不知道,到底为什么要学习编程。  很多同学大一就开设了C语言的课,我也上过,但是那时候就是天天几乘几,...

    s-HR实施FAQV2.0

    会议主要议程之一就是组织参加会议的顾问一起编写一个文档,希望这个文档能在大家的日常项目实施过程中起到帮助指导作用,如果遇到一些不知道如何解决的操作性的问题,可以通过它,快速、准确地找寻到解决方案。...

    一份优秀的数据分析报告产出流程.doc

    没有人在意你的结果是来自Excel表格还是 一段自己用R语言编写的程序。 一旦整理出了你需要的信息,就为这份报告写一个概述,这样你就会知道你都要写些 什么内容。这样做可以帮助你不偏离主线。你的总结或许可以选择...

    Selenium用户指南

    在阅读时,你可能遇到打字错误或其他的较小的错误。如果如此,请保持对我们的耐心。不是隐藏信息直到最终完成,我们频繁地检查和修订新的资料。尽管如此,我们首先检查我们的素材和我们对我们提交的信息的精确性和...

    《你必须知道的495个C语言问题》

    你难免会遇到各种各样的问题,有些可能让你百思不得其解,甚至翻遍图书馆,也找不到问题的答案。 《你必须知道的495个C语言问题》的出版填补了这一空白。许多知识点的阐述都是其他资料中所没有的,弥足珍贵。 涵盖...

    robotframework脚本编写规范.pdf

    robotframework脚本编写规范 脚本编写规范 测试集、脚本 测试集、脚本 测试脚本的名字不要超过20个字符,⽂件类型应该为txt 名字必需易读且有意义(看名知意) 记住测试集的名字是⾃动根据⽂件、⽬录的名字创建的。...

    sorry-txt:您为其他开发人员留下的遗憾说明,因为您可能会给他们留下蹩脚的代码

    您确实冒着奇怪的风险,将其视为软弱的表现,甚至对此更加愤怒(毕竟,如果开发人员不知道他们正在编写糟糕的代码,也许这是情有可原的?)。尖端含糊其辞 - 你只是为了同情如果代码足够糟糕,您

Global site tag (gtag.js) - Google Analytics