1.软件开发文档应该如何写
模块开发卷宗(GB8567——88)
1标题
软件系统名称和标识符
模块名称和标识符(如果本卷宗包含多于一个的模块,则用这组模块的功能标识代替模块名)
程序编制员签名
卷宗的修改文本序号
修改完成日期
卷宗序号(说明本卷宗在整个卷宗中的序号)
编排日期(说明整个卷宗最近的一次编排日期)
2模块开发情况表
3功能说明
扼要说明本模块(或本组模块)的功能,主要是输入、要求的处理、输出。可以从系统设计说明书中摘录。同时列出在软件需求说明书中对这些功能的说明的章、条、款。
4设计说明
说明本模块(或本组模块)的设计考虑,包括:
a. 在系统设计说明书中有关对本模块(或本组模块)设计考虑的叙述,包括本模块在软件系统中所处的层次,它同其他模块的接口;
b. 在程序设计说明书中有关对本模块(或本组模块)的设计考虑,包括本模块的算法、处理流程、牵涉到的数据文卷设计限制、驱动方式和出错信息等;
c. 在编制目前已通过全部测试的源代码时实际使用的设计考虑。
5原代码清单
要给出所产生的本模块(或本组模块)的第一份无语法错的源代码清单以及已通过全部测试的当前有效的源代码清单。
6测试说明
说明直接要经过本模块(或本组模块)的每一项测试,包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出。
7复审的结论
把实际测试的结果,同软件需求说明书、系统设计说明书、程序设计说明书中规定的要求进行比较和给出结论。
2.谁来帮我把这些翻译成英文
A feasibility report
2 Project Development Plan
3 Requirements Specification
4 Data requirements specification
5 Test Plan
6 Summary of Design Manual
7 Detailed design specifications
8 Database Design Manual
9 User Guide
10 Test Solutions
11 test cases
12 report
13 Module Development files
14 test reports
15 Software Report
Report of 16 software changes
17 Program Maintenance Manual
18 Development Progress Report
19 summary report of Project Development
3.寻求软件的开发与设计完整方案流程
标准的软件开发过程 1推荐 软件开发的标准过程包括六个阶段,而六个阶段需要编写的各类文件达14种之多,在每个阶段需要编写哪些文件,以及这些文件的主要内容见下: 1.可行性与计划研究阶段 可行性研究报告:在可行性研究与计划阶段内,要确定该软件的开发目标和总的要求,要进行可行性分析、投资一收益分析、制订开发计划,并完成应编制的文件。
项目开发计划:编制项目开发计划的目的是用文件的形式,把对于在开发过程中各项工作的负责人员、开发进度、所需经费预算、所需软、硬件条件等问题作出的安排记载下来,以便根据本计划开展和检查本项目的开发工作。 2.需求分析阶段 软件需求说明书:软件需求说明书的编制是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解, 使之成为整个开发工作的基础。
内容包括对功能的规定对性能的规定等。 数据要求说明书:数据要求说明书的编制目的是为了向整个开发时期提供关于被处理数据的描述和数据采集要求的技术信息。
初步的用户手册:用户手册的编制是要使用非专门术语的语言,充分地描述该软件系统所具有的功能及基本的使用方法。使用户(或潜在用户)通过本手册能够了解该软件的用途,并且能够确定在什么情况下,如何使用它。
3.设计阶段 概要设计说明书:概要设计说明书又可称系统设计说明书,这里所说的系统是指程序系统。编制的目的是说明对程序系统的设计考虑,包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计。
运行设计、数据结构设计和出错处理设计等,为程序的详细设计提供基础。 详细设计说明书:详细设计说明书又可称程序设计说明书。
编制目的是说明一个软件系统各个层次中的每一个程序 (每个模块或子程序)的设计考虑,如果一个软件系统比较简单,层次很少,本文件可以不单独编写,有关内容合并入概要设计说明书。 数据库设计说明书:数据库设计说明书的编制目的是对于设计中的数据库的所有标识、逻辑结构和物理结构作出具体的设计规定。
测试计划初稿:这里所说的测试,主要是指整个程序系统的组装测试和确认测试。本文件的编制是为了提供一个对该软件的测试计划,包括对每项测试活动的内容、进度安排、设计考虑、测试数据的整理方法及评价准则。
4.实现阶段 模块开发卷宗(开始编写):模块开发卷宗是在模块开发过程中逐步编写出来的,每完成一个模块或一组密切相关的模块的复审时编写一份,应该把所有的模块开发卷宗汇集在一起。编写的目的是记录和汇总低层次开发的进度和结果,以便于对整个模块开发工作的管理和复审,并为将来的维护提供非常有用的技术信息。
用户手册完工 操作手册:操作手册的编制是为了向操作人员提供该软件每一个运行的具体过程和有关知识,包括操作方法的细节。 测试计划终稿:5.测试阶段 模块开发卷宗(此阶段内必须完成) 测试分析报告:测试分析报告的编写是为了把组装测试和确认测试的结果、发现及分析写成文件加以记载。
项目开发总结报告:项目开发总结报告的编制是为了总结本项目开发工作的经验,说明实际取得的开发结果以及对整个开发工作的各个方面的评价。 6.运行与维护阶段 开发进度月报的编制目的是及时向有关管理部门汇报项目开发的进展和情况,以便及时发现和处理开发过程中出现的问题。
一般地,开发进度月报是以项目组为单位每月编写的。如果被开发的软件系统规模比较大,整个工程项目被划分给若干个分项目组承担,开发进度月报将以分项目组为单位按月编写。
对于一项软件而言,有些文件的编写工作可能要在若干个阶段中延续进行。 鉴于软件开发是具有创造性的脑力劳动,也鉴于不同软件在规模上和复杂程度上差别极大,本指南认为在文件编制工作中应允许一定的灵活性,并不是14种文件每种都必须编写。
文件编制的衡量因素 ◆在因素总和较低的情况下,项目开发总结报告的内容应包括:程序的主要功能、基本流程、测试结果和使用说明。 ◆测试分析报告应该写,但不必很正规。
◆数据要求说明和数据库设计说明是否需要编写应根据所开发软件的实际需要来决定。 例2:为了避免在软件开发中文件编制的不足或过分,一个简便的办法是把对软件文件的编制要求同软件的规模大小联系起来,这就是本例的出发点。
软件的规模不妨分为四级: 1.小规模软件源程序行数小于5 000的软件; 2.中规模软件源程序行数为 10 000~ 50 000的软件; 3.大规模软件源程序行数为 100 000?500 000的软件; 4.特大规模软件源程序行数大于500 000的软件。 对上述的四级软件的文件编制要求分别列于表O3。
至于源程序行数为 5 000~ 10 000, 50 000~ 100 000的软件,其文件编制要求介于两级之间,可根据一个软件产品的具体情况,由项目负责人参照表O3的规定,确定需要编制的文件种类。 对于源程序行数大于500 000的特大规模软件,可进一步把本指南规定的十四种文件按实际需要扩展成更多种类。
4.软件开发需要哪些文档
如,开发阶段、文档化要求程度等,若是通过CMM评估的,文档就较多
一般的是按项目开发过程来分,基本的有可行性研究报告(若是一个新项目且未确定的或应客户要求时需要,实际上大部份公司很少有这文档)
用户需求说明书(用户+开发人员共同确认)
软件需求规格说明书
设计说明书(体系结构、详细设计)测试用例用户手册实现代码
这些文档中,包括一定的分析与设计图形,如用例图、数据库结构、ER图等
当然项目计划、测试计划也应算在内
其它的(如CMM要求的)
风险、估算方面的,质量保证方面的、配置管理方面、定义的模板、度量数据库等
具体需要多少文档就是要看项目实际这方面的东西,可参考一些软件工程类的书
5.软件需求说明怎么写
原发布者:管理资源吧
软件需求说明书的编写提示1引言1.1编写目的说明编写这份软件需求说明书的目的,指出预期的读者。1.2背景说明:a.待开发的软件系统的名称;b.本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络;c.该软件系统同其他系统或其他机构的基本的相互来往关系。1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4参考资料列出用得着的参考资料,如:a.本项目的经核准的计划任务书或合同、上级机关的批文;b.属于本项目的其他已发表的文件;c.本文件中各处引用的文件、资料、包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。2任务概述2.1目标叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。解释被开发软件与其他有关软件之间的关系。如果本软件产品是一项独立的软件,而且全部内容自含,则说明这一点。如果所定义的产品是一个更大的系统的一个组成部分,则应说明本产品与该系统中其他各组成部分之间的关系,为此可使用一张方框图来说明该系统的组成和本产品同其他各部分的联系和接口。|2.2用户的特点列出本软件的最终用户的特点,充分说明操作人员、维护人员的教育水平和技术专长,以及本软件的预期使甩频度。这些是软件设计工作的重要约束2.3假定和约束列出进行本软件开发工作的假定和约束,例如经费限制、开发期限等。3需求规定3
6.案卷题名怎么填写
文书档案案卷题名的拟写方法:
案卷题名就是一个案卷的名称、题目,它是以简练准确的语言概括揭示卷内文件的内容与成分。它是手工管理档案阶段非常重要的一种检索指南,也是档案人员对档案进行登记造册、编制各种检索工具的基础,所以拟写或修改案卷题名是立卷人员及档案管理人员必须做好的一项基本工作。笔者认为,拟写文书档案案卷题名时,应注意以下几个问题:
1、具体要求:
(1)文字简练、内容概括。一个案卷中有若干份文件,每份文件都反映一定的内容,要想一一列举是不可能的,也无必要。应当用简明、概括的文字将卷内最基本、最主要的内容揭示出来。案卷题名的字数一般保持在三、四十个字之内,最多不超过五十个字。尤其是目前,许多单位推行立小卷,问题比较单一,案卷题名用三、四十个字完全可以说明问题。对于问题比较杂的案卷,应按问题分成几个小卷,再分别拟写标题。
(2)结构完整。案卷题名一般由三部分构成,即责任者、问题、名称。文件内容针对特定时间的,题名中要标明年度,反映往来文书的,要标明收发文机关。具体每类案卷采用哪种形式,详见下文——案卷题名的构成形式。
(3)标点符号使用正确。从语法上讲,案卷题名不是一个完整的句子,而是一个偏正关系的词组。所以末尾一般不加句号,题名中如出现多个责任者或多种文件名称,并列的成分中间可用顿号。
2、案卷题名的构成形式:
(1)责任者+关于+问题+的+名称。这种形式适合于专题类文件组成的卷,即由一个单位在管理和业务工作中形成的政策规定、调研报告、请示批复、通知等文件组成的卷。这类文件是单位归档文件的主要组成部分,因而文书档案中80%的案卷提名均采用这种形式。如:宜昌市第一中学关于新教师培养工作的意见、方案。
(2)责任者+文件针对时间+问题+名称。这种形式适合于综合类、特殊形式的文件组成的卷,即由工作总结、计划、规划、安排、统计报表、名册、介绍信、党政会议记录等组成的案卷,这类文件时间性比较强,在标题中突出时间特征,便于检索和利用。如:宜昌市第一中学党委2001年工作计划、总结;宜昌市第一中学2002-2003学年度普通中学基层报表,宜昌市第一中学1999年行政会议记录、纪要等。
(3)时间+出版物名称。这种形式适合于单位编印的各种简报、信息、动态及公开出版的刊物等。如:2001年1-8期《宜昌市一中报》,2001年1-5期《一中简报》等。
(4)会议名称+文件。这种形式适合于会议文件组成的卷,召开一个会议可能产生请示报告卡、会议通知、秩序册、议程、会议讲话、报告、总结、典型材料等,如果将其内容、文件名称全部标出,题名显得很繁琐,可采用一种简洁 的方法,只点明会议名称,后面加上文件即可。如:宜昌市第五届三次教代会会议文件。 (5)通讯者+关于+问题+的+来往文书(或文件名称)。这种形式适合于由单位之间商洽工作的问函与复函、合同、协议书组成的案卷。宜昌市第一中学与XX建筑公司关于建造教学图书大楼的来往文书。 但对于重要问题的请示与批复、报告、指示,应另行立卷并具体标出文件名称。
7.软件开发制作流程是怎样的
具体流程参考以下步骤:
1、首先制定项目计划,最初计划是里程碑性质的。可以先按瀑布模型设置,里程碑点主要为需求评审、设计评审、经过代码开发和单元测试后进行集成测试、部署上线是一个很重要的里程碑,一般用户会期望系统何时能使用,进入试运行期。
2、需求开发阶段:怎么样写好需求很关键,这个需要实践经验锻炼自己。如果有项目成员,可以一起做需求,这个阶段对于业务理解、分析、如何开展调研以及文字表述、业务流程图描述还有文档编辑能力都有不少要求。一般分为《用户需求说明书》和《需求规格说明书》,小项目可以写一个《需求分析报告》,《用户需求说明书》是用用户的语言进行描述,让用户和开发团队对于需求的达成一致的理解,《需求规格说明书》,则是对用户需求的分析,形成系统要具有的功能,这个是真正提供用户可交互操作的文档,也就是后期设计和代码开发的重要基线。
另外,作为了解需求,拿出用户UI和用户交流也是一项比较重要的需求获取手段,虽然这个属于设计的范畴
3、系统设计阶段:
系统总体架构,结合用户对系统环境、开发语言以及运行的网络硬件等要求,确定开发工具等,对应用系统关系进行架构性设计,通过需求阶段对用户的分析归类,用图的方式描述出用户和各子系统或模块的全局视图,以及和其他系统的关系。也就是搞清楚系统的边界问题。
概要设计中除了高层架构设计,还需要设计网络拓扑图,以及系统部署图。概要设计比较重要的还有就是子系统、模块进行合理的划分。模块的名称很大程度上会成为用户的主要菜单,如何用用户的角度去取比较清楚的子系统和模块是很重要的。
4、代码开发和单元测试阶段:这个阶段一般来说需要改进瀑布模型,类似跌代开发,把模块进行合理划分,把项目总体计划的代码开发测试阶段划分为多个时间段,每个时间段都包括代码开发、单元测试和集成测试,这个阶段还需要对需求变更进行跟踪控制,如果需求有变更,那么要把需求文档、设计文档都重新跟上。跌代开发的好处就是不让代码开发阶段拉的过程,没有进行及时的自我检查,不小心到了提交时间,却不是用户想要的,还有可能都不是自己想要的。
项目经理重要的责任是控制好进度,能及早发现风险,并能拿出好的预防和解决办法的措施。合理安排好开发团队的任务,合时的任务安排和衔接,你会觉得非常有艺术感,这个要自己体会了。另外,关注项目团队各人员的状况,保持高的战斗力,及时发现并能鼓励团队共同朝一个目标前进。
5、测试工作,测试是项目的很重要的环节,怎么测试,怎么准确测试,怎么有效测试,怎么覆盖测试,时间、人手、经验扽个方面都会有制约。高级测试人员能够分析系统各测试要点,在需求、设计阶段都要参与,提早了解如何去测试,能写出测试用例。
6、文档工作,文档在项目开发中也占有重要位置,除非你觉得代码是项目唯一的成果,那么你把文档抛掉吧,什么都在你的脑子里,团队中人员一走,项目的一部分也就带走了。代码开发其实也需要文档,代码是成果,代码注释是成果,模块开发卷宗也是重要的成果,因为程序员在开发时候的逻辑是怎么样的,对于今后查问题很有作用。除非你的系统设计程度到了方法、类,把代码逻辑也都设计好了,那么程序员就CODEING去吧。
7、QA是对项目过程的质量保障,有些公司吧QA和测试工作合成一个岗位叫做QA&;测试人员,或者就叫QA人员。QA是对项目全过程的监管,独立于项目之外。监督项目经理在各项目里程碑提交相关成果,入库形成基线。
8.软件开发流程有哪些,软件后期维护怎么做
软件后期的维护怎么做呢?依据我们的软件开发经验,下面为大家进行介绍
1. 做好更新计划:
做好更新计划主要是涉及两方面的考虑,第一就是内部开发人员可以有一个详细的更新步骤以及任务安排,第二就是对客户来说也是一个很好的项目实施的结果展示。更新计划也可看成是项目的阶段性成果,作为与客户相互沟通的一部分文档资料。
2. 实时告诉客户每次的更新成果:
这个主要是为了将每次的更新成果实时的告诉客户,有些客户他不管你做的项目到底进行的怎么样了,他要的只是结果,有段时间他可能很忙,他就不管,但是他一有空闲他就会向你询问项目的进展情况,这时你告诉他已经更新过了还是….,所以最郁闷的就是你更新过了,客户又打电话过来问你项目的进展情况。这样的事我在项目进行过程中深有体会,派一个项目组员过去将进行系统更新,但是组员又没告诉客户他这次来更新的工作内容,只是提前告诉客户某天我们回来人进行系统的更新,所以客户也对系统的更新情况不了解,所以最好的做法就是实时告诉客户工作的具体内容。
3. 实时从客户那里获取最新的意见:
这个主要是涉及到具体的功能的实现问题,比如某个功能在跟客户交流的时候他说要实现一下,但是按照我们开发者的思维去思考的话总是按照技术角度去考虑问题,有些客户提出的问题会不放在心上,这样与客户交流回来后进行系统更新计划,但是有时你做的这些工作不是客户想要的,他说出来的也许就是对他来说最重要的功能,所以为了减少工作量,一定要听取客户的意见,实时的把握客户的需求,这样每次做的工作才能满足客户的最大需求。
总之,在去客户那里配置更新后的系统前,每次都做好更新计划和实时步骤以及更新成果。