计算机软件开发文档编写规范-分析软件需求分析就是回答做什么的的问题？

分析

软件需求分析就是回答做什么的问题。它是一个去粗取精，去伪存真，正确理解用户需求，然后用软件工程开发语言(形式化功能规范，即需求规范)表达的过程。这个阶段的基本任务是和用户一起确定需要解决的问题，建立软件的逻辑模型，编制需求规格说明文档，最终被用户认可。需求分析的主要方法包括结构化方法、数据流程图和数据字典。这一阶段的工作是根据需求说明书的要求设计和建立相应的软件系统架构，将整个系统分解为若干个子系统或模块，定义子系统或模块之间的接口关系，对每个子系统进行具体的设计定义，编制软件概要设计和详细设计说明书、数据库或数据结构设计说明书、装配测试计划。

设计

软件设计可以分为两个阶段：概要设计和详细设计。其实软件设计的主要任务就是把软件分解成模块，模块指的是能够实现某一功能的数据和程序描述，以及能够执行程序的程序单元。它可以是一个函数、一个过程、一个子程序、一个独立的程序和带有程序描述的数据，或者是一个可组合、可分解和可替换的功能单元。模块，然后设计模块。概要设计是结构设计，其主要目标是给出软件的模块结构，用软件结构图来表示。详细设计的首要任务是设计模块的程序流程、算法和数据结构，次要任务是设计数据库。常见的方法是结构化编程。

编码

软件编码是指将软件设计转化为计算机可接受的程序，即编写一份用某种编程语言表达的“源程序清单”。充分了解软件开发语言、工具特点和编程风格，有助于开发工具的选择，保证软件产品的开发质量。

目前，除了特殊场合，软件开发很少使用80年代的高级语言，而是使用面向对象的开发语言。而且面向对象的开发语言和开发环境大多是集成的，大大提高了开发速度。

试验

软件测试的目的是以较小的成本找到尽可能多的错误。实现这个目标的关键是设计一套优秀的测试用例(测试数据和预期的输出结果构成测试用例)。如何设计一套优秀的测试用例，取决于对测试方法的理解。不同的测试方法有不同的测试用例设计方法。两种常用的测试方法是白盒法，其中测试对象是源程序，根据程序内部逻辑结构发现软件编程错误、结构错误和数据错误。结构错误包括逻辑、数据流、初始化和其他错误。用例设计的关键是用更少的用例覆盖尽可能多的内部程序逻辑结果。白盒法和黑盒法是基于软件功能或软件行为描述，发现软件界面、功能和结构错误。接口错误包括内部/外部接口、资源管理、集成和系统错误。黑盒用例设计的关键是用更少的用例覆盖模块输出和输入接口。黑盒法。

保持

维护是指软件开发(分析、设计

计、编码和测试）工作并交付使用以后，对软件产品所进行的一些软件工程的活动。即根据软件运行的情况，对软件进行适当修改，以适应新的要求，以及纠正运行中发现的错误。编写软件问题报告、软件修改报告 。

一个中等规模的软件，如果研制阶段需要一年至二年的时间，在它投入使用以后，其运行或工作时间可能持续五年至十年。那么它的维护阶段也是运行的这五年至十年期间。在这段时间，人们几乎需要着手解决研制阶段所遇到的各种问题，同时还要解决某些维护工作本身特有的问题。做好软件维护工作，不仅能排除障碍，使软件能正常工作，而且还可以使它扩展功能，提高性能，为用户带来明显的经济效益。然而遗憾的是，对软件维护工作的重视往往远不如对软件研制工作的重视。而事实上，和软件研制工作相比，软件维护的工作量和成本都要大得多。

在实际开发过程中，软件开发并不是从第一步进行到最后一步，而是在任何阶段，在进入下一阶段前一般都有一步或几步的回溯。在测试过程中的问题可能要求修改设计，用户可能会提出一些需要来修改需求说明书等。

1、项目设计

项目设计的主导思想，我觉得可以理解为两种，一种是完全设计，一个是简单设计。

完全设计是指在具体编写代码之前对软件的各种方面都调查好，做好详细的需求分析、编写好全部的开发文档，设计出程序全部流程后再开始写代码。 换句话说，就是全部的计划好了，能看到最终的样子，再开战。这好像也是很多“软件工程”书里要求的那样。开始的时候，我觉得这种方法不错也。什么都计划好了，照着做就是了。不过这里有个明显的问题，就是谁来做这个完美的计划？估计只有及其BT的人了，但是大部分人的想要完全设计计算机软件开发文档编写规范，并且没有错误，或者已经有几种后备的容错方案，并能准确无误的推行。以达到最终目标。这样的境界，没有很多年的工作经历是不可能的。我也没有这样的本事，所以我也就放弃了这种想法。

简单设计：简单设计一种概念，一种可以接受的简单的设计，最起码数据库已经定下来，基本流程已经确定的方案，来作为程序设计的开始，并随时根据实际情况的进展来修正具体的功能设计，但这种功能修改不能是修改数据库结构。也就是说数据库结构是在编程之前经过反复论证的。这种方法减少了前期设计的时间，把代码编写工作和部分设计工作放在了一起，实际缩短了项目开发的时间。如果说完全设计方法要求有很厉害的前期设计人员，那么简单设计要求有很有设计头脑的编程人员。编程人员不仅仅是K代码的人而且要负责程序架构的设计。所以对程序员的要求就很高了。 简单设计的成功的一个基点是编程人员设计的逻辑结构简单并能根据需要来调整其逻辑结构，就是代码结构灵活，简单设计带来的另外一个变化就是会议会比较多，编程人员之间的交流就变的很重要。现在一般的中小型软件公司基本上都是采用简单设计的，除非那些很大型的软件公司。

总结，简单设计考验的是开发人员的能力。完全设计考验的是前期设计人员和整个项目组完整能力。(各种文档的编写，开发人员一定会要写一部分的。)

2、设计变化和需求变化

开发人员最怕的是什么呢？设计变化，还是需求变化？我觉得需求变化是最最致命的。当你的一个项目数据库都定下来后，而且已经开发了若干个工作日，突然接到甲方公司提出，某个功能要改变，原先的需求分析要重新改，如果这个修改是涉及的数据库的表结构更改的话，那真是最致命的。这就意味着项目的某些部分得重新推倒重来，如果这个部分跟已完成的多个部分有牵连的话，那就后果更可怕了。所以当碰到这种情况发生，作为项目经理的你就应该考虑先查责任人，究竟是自己的需求分析做的不够好，还是客户在认同了需求分析后做出的修改，如果是后者的话，你完全可以要求客户对他的这个修改负责任！那么，呵呵，客户先生，对不起了，本次新增加的需求将归入另外一个版本。如果是改变前面某个需求的定义，那么说不定就要推倒重来了，不过这个时候到不用太在意，毕竟错的是客户。(项目正式开始前没有没有说清楚其需求)。所以，各位看客，在需求分析做好后，在开工之前一定要叫客户认可签字，并且在合同上要注明，当由客户原因引起的需求改变而造成开发成本的增加，客户要为此买单地。

如果在需求不变的情况之下，设计发生了变化，这个仅仅是我们内部之间的矛盾，商量一下就能解决。在简单设计中，因为前期的设计是不完整的，那么当进入任何一个新的模块进行开发时，都有可能引起设计的变化。开发人员的水平的高低就基本上决定了软件的好坏。

3、代码编写

当需求定下来数据库也定下来后， 其实我们就可以进行实质性的编码了，按照我的看法，一个人单独编程最好，能随时偷懒。(上网，和MM聊聊)，但是现在的软件项目越来越大，工期也越来越紧，事实上我们一个小组里面，一般有3-5程序员，所以我们要强调团队合作性。那么你写的代码使得别人要能够看懂，我们必须在实际的编写代码过程中要有详细的编码规范，编码规范在很多书籍里面都提到过。但最起码以下的一些规范是我们必须要遵守的：

一）源程序文件结构：

每个程序文件应由标题、内容和附加说明三部分组成。

（1）标题：文件最前面的注释说明，其内容主要包括：程序名，作者，版权信息，简要说明 等，必要时应有更详尽的说明（将以此部分以空行隔开单独注释）。

（2）内容控件注册等函数应放在内容部分的最后，类的定义按 private 、 protected 、 pubilic 、 __pubished 的顺序，并尽量保持每一部分只有一个，各部分中按数据、函数、属性、事件的顺序。

（3）附加说明：文件末尾的补充说明，如参考资料等，若内容不多也可放在标题部分的最后。

二）界面设计风格的一致性：

由于采用可视化编程，所有的界面均与Win32方式类似，相应采用的控件等也大都为Windows操作系统下的标准控件，而且参考了其他一些市面上相关的企业内部管理的应用软件。

基于简单易操作的原则计算机软件开发文档编写规范，贴近用户考虑，用户界面采用Windows风格的标准界面，操作方式亦同Windows风格，这样在实施过程，可以降低对客户的培训，也可以使用户容易上手，简单易学。

三）编辑风格：

（1）缩进：缩进以 Tab 为单位，一个 Tab 为四个空格大小。全局数据、函数 原型、标题、附加说明、函数说明、标号等均顶格书写。

（2）空格：数据和函数在其类型，修饰（如 __fastcall 等）名称之间适当空格并据情况对 齐。关键字原则上空一格，不论是否有括号，对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。

（3）对齐：原则上关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。

另每一行的长度不应超过屏幕太多，必要时适当换行。

（4）空行：程序文件结构各部分之间空两行，若不必要也可只空一行，各函数实现之间一般空两行。

（5）注释：对注释有以下三点要求：

A、必须是有意义；

B、必须正确的描述了程序；

C、必须是最新的。

注释必不可少，但也不应过多，以下是四种必要的注释：

标题、附加说明；

函数说明：对几乎每个函数都应有适当的说明，通常加在函数实现之前，在没有函数实现部分的情况下则加在函数原型前，其内容主要是函数的功能、目的、算法等说明，参数说明、返回 值说明等，必要时还要有一些如特别的软硬件要求等说明；

在代码不明晰或不可移植处应有少量说明；

及少量的其它注释。

四）命名规范：

坚持采用匈牙利变量命名惯例，所有标识符一律用英文或英文缩写，杜绝采用拼音，标识符中每个单词首字母大写，缩写词汇一般全部大写，只在必要时加“_”间隔词汇。

4、BUG修补

程序出现了BUG谁来修补呢，嘿嘿嘿……

最好的办法是谁编写谁修补，谁改坏谁修补。一个人改坏的代码一人去修。两个人一起改坏的代码两人一起修。

5、开发人员的测试

开发人员的测试是保证代码能正常运行，在开发时候发现的错误往往比较容易修正。(另外一个好处就是没有人来骂你。因为只有你自己知道)。但是一旦软件到了测试小组那里出了问题，那么就多了很多时间来修正BUG，如果到了客户哪里才发现的BUG，那么时间就更长了，开发人员本身受到的压力也是到了最大话了。客户->公司->测试小组->开发人员。 这个完全是倒金字塔型的，承受能力差的一环很容易出事情的。

另外开发人员的测试除了保证代码能正常运行以外，还有一个很重要的方面就是要保证上次能正常运行的代码，这次还是能正常运行。如果做不到这点，那么BUG就不断的会出现，很多BUG也会反复出现。于是软件看上去就有修补不完的BUG了。如果出现这种情况，那么开发人员有必要再教育。一般公司教育的方式有四种。第一种，扣工资，第二种，加班，反复加班+精神攻击。 第三种，开除。第四种，调动人员来帮助那个出了麻烦的家伙。 但愿看这个文章的人不要受到前面三种教育。