`
lujunyi2001
  • 浏览: 2057 次
  • 性别: Icon_minigender_1
  • 来自: 天津
最近访客 更多访客>>
社区版块
存档分类
最新评论

项目开发文档——软件维护手册

阅读更多
1 引言
1.1 编写目的:阐明编写手册的目的并指明读者对象。
1.2 项目背景:说明项目的提出者、开发者、用户和使用场所。
1.3 定义:列出报告中所用到的专门术语的定义和缩写词的原意。
1.4 参考资料:列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,及保密级别,可包括:用户操作手册;与本项目有关的其他文档。
2 系统说明
2.1 系统用途:说明系统具备的功能,输入和输出。
2.2 安全保密:说明系统安全保密方面的考虑。
2.3 总体说明:说明系统的总体功能,对系统、子系统和作业做出综合性的介绍,并用图表的方式给出系统主要部分的内部关系。
2.4 程序说明:说明系统中每一程序、分程序的细节和特性。
2.4.1 程序1的说明
  ● 功能:说明程序的功能。
  ● 方法:说明实现方法。
  ● 输入:说明程序的输入、媒体、运行数据记录、运行开始时使用的输入数据的类型和存放单元、与程序初始化有关的入口要求。
  ● 处理:处理特点和目的,如:用图表说明程序的运行的逻辑流程;程序主要转移条件;对程序的约束条件;程序结束时的出口要求;与下一个程序的通信与联结(运行、控制);由该程序产生并茶馆处理程序段使用的输出数据类型和存放单元;程序运行存储量、类型及存储位置等。
  ● 输出:程序的输出。
  ● 接口:本程序与本系统其他部分的接口。
  ●表格:说明程序内部的各种表、项的细节和特性。对每张表的说明至少包括:表的标识符;使用目的;使用此表的其他程序;逻辑划分,如块或部,不包括表项;表的基本结构;设计安排,包括表的控制信息。表目结构细节、使用中的特有性质及各表项的标识、位置、用途、类型、编码表示。
  ● 特有的运行性质:说明在用户操作手册中没有提到的运行性质。
2.4.2程序2的说明
  与程序1的说明相同。以后的其他各程序的说明相同。
3 操作环境
3.1 设备:逐项说明系统的设备配置及其特性。
3.2 支持软件:列出系统使用的支持软件,包括它们的名称和版本号。
3.3 数据库:说明每个数据库的性质和内容,包括安全考虑。
3.3.1总体特征:如标识符、使用这些数据库的程序、静态数据、动态数据;数据库的存储媒体;程序使用数据库的限制。
3.3.2结构及详细说明
  ● 说明该数据库的结构,包括其中的记录和项。
  ● 说明记录的组成,包括首部或控制段、记录体。
  ● 说明每个记录结构的字段,包括:标记或标号、字段的字符长度和位数、该字段的允许值范围。
  ● 扩充:说明为记录追加字段的规定。
4 维护过程
4.1 约定:列出该软件系统设计中所使用全部规则和约定,包括:程序、分程序、记录、字段和存储区的标识或标号助记符的使用规则;图表的处理标准、卡片的连接顺序、语句和记号中使用的缩写、出现在图表中的符号名;使用的软件技术标准;标准化的数据元素及其特征。
4.2 验证过程:说明一个程序段修改后,对其进行验证的要求和过程(包括测试程序和数据)及程序周期性验证的过程。
4.3 出错及纠正方法:列出出错状态及其纠正方法。
4.4 专门维护过程:说明文档其他地方没有提到的专门维护过程。如:维护该软件系统的输入输出部分(如数据库)的要求、过程和验证方法;运行程序库维护系统所必需的要求、过程和验证方法;对闰年、世纪变更的所需要的临时性修改等。
4.5 专用维护程序:列出维护软件系统使用的后备技术和专用程序(如文件恢复程序、淘汰过时文件的程序等)的目录,并加以说明,内容包括:维护作业的输入输出要求;输入的详细过程及在硬设备上建立、运行并完成维护作业的操作步骤。
4.6 程序清单和流程图:引用或提供附录给出程序清单和流程图。

分享到:
评论

相关推荐

    国家标准软件开发文档模板————可以帮助一些不喜欢些项目文档的或者是不知道怎么写文档的朋友解决很大的问题!~试试看

    使用国家标准软件开发文档模板GB856T——88.aibxyz,你可以按照这些结构来组织你的文档,确保它们符合国家规定的标准,有利于团队间的沟通和项目的顺利进行。每个部分都应详细、准确地填写,以保证所有项目参与者都...

    软件开发——国家标准文档

    在软件开发过程中,国家标准文档是指导项目顺利进行的重要依据,它们确保了开发团队遵循一致的规范,提高了软件质量,降低了沟通成本。以下是一些关键的软件工程国家标准文档及其详细内容: 1. **需求规格说明书**...

    国标软件开发文档【GB8567——88】

    《国标软件开发文档【GB8567——88】》是中国国家标准中关于软件开发文档编制的一个重要规范,旨在为国内的软件开发提供统一、规范化的文档编写指南。这一标准在1988年发布,对软件生命周期中的各个阶段所需文档进行...

    国家标准——软件开发规范

    总的来说,《国家标准——软件开发规范》是一份全面而实用的指导文件,它涵盖了软件开发的各个关键环节,通过标准化的文档管理,推动了软件行业的健康发展。无论是初入行的新手还是经验丰富的开发者,都应将其作为...

    软件项目开发的全套文档提纲

    在软件工程领域,一个完整的软件项目开发过程不仅包括编程实现,更重要的是有一套规范的文档支持,确保项目的可维护性、可扩展性和团队间的有效沟通。以下是对"软件项目开发的全套文档提纲"的详细解释: 1. **项目...

    项目开发文档 项目开发文档

    本压缩包包含的“软件项目开发的全套文档——资料包(15个DOC)”显然是一个全面的资源,涵盖了项目开发的各个阶段,包括需求分析、设计、实施、测试以及维护等环节。 首先,我们来讨论项目开发文档的重要性。项目...

    软件项目开发全套文档

    《软件项目开发全套文档》是一份综合性的资源集合,涵盖了软件开发过程中的多个关键环节,旨在为开发者提供全面且标准的指导。这份文档集的得分高达4分,表明其内容的高质量和实用性,是开发团队不可或缺的参考资料...

    规范化文档——ISB开发设计文档

    最后,项目维护阶段需要《用户手册》和《技术文档》来支持用户使用和后期维护。用户手册提供了操作指南,帮助用户理解和使用软件,而技术文档则包含系统内部工作原理,供开发人员参考。 总之,"ISB开发设计文档"是...

    软件项目开发的文档(全套)

    本套文档涵盖了软件项目开发的各个关键阶段,是程序员提升专业技能、项目经理进行有效管理的重要参考资料。以下是根据提供的文件名解析出的主要知识点: 1. **概要设计说明书** (3-概要设计说明书(GB8567——88)1...

    C#软件项目开发全程剖析——全面透视SharpDevelop软件的开发内幕.rar

    总的来说,《C#软件项目开发全程剖析——全面透视SharpDevelop软件的开发内幕》不仅讲解了C#语言的基础与高级特性,还涵盖了软件工程的多个方面,包括项目管理、设计模式、测试策略、文档编写等,为读者提供了全面的...

    国家标准软件开发文档模板GB856T——88

    1. **文档类型**:GB8567-88定义了多种类型的软件开发文档,包括需求规格说明书、设计规格说明书、用户手册、程序员手册、测试计划、测试报告、系统维护手册等。这些文档在整个软件生命周期中扮演着不同角色,帮助...

    软件开发文档规范国家标准

    《软件开发文档规范国家标准》是指导软件开发过程中的重要指南,它确保了团队之间的有效沟通,项目的有序进行,以及最终产品的质量和可维护性。以下是对这些文档的详细说明: 1. **可行性研究报告(GB8567——88)*...

    java软件技术文档(软件需求规格说明文档模板)

    《Java软件技术文档——软件需求规格说明文档模板》 软件需求规格说明文档是软件开发过程中的重要组成部分,它详细定义了软件的功能、性能、界面以及与其他系统交互的方式。这份模板适用于Java软件开发,为开发者...

    项目文档书写规范——国标

    总结来说,遵循国标规范的项目文档书写,能够保证项目有序进行,降低沟通成本,提升开发效率,同时也便于后期的维护和升级。对于每个IT从业者而言,理解和应用这些规范都是其专业素养的重要组成部分。

    软件项目开发文档模版.rar

    《软件项目开发文档模版》是一个非常实用的资源,它包含了一系列按照GB8567-88标准制定的文档模板,适用于软件开发过程中的各个阶段。这些文档是软件工程中不可或缺的部分,对于保证项目的规范性和成功至关重要。...

    软件项目开发的全套文档提纲.rar

    "软件项目开发的全套文档提纲.rar" 提供了遵循国标GB8567——88的标准范本,旨在指导开发者如何系统地组织和编写各种必要的文档。下面,我们将详细探讨这套文档提纲中的关键知识点: 1. **项目启动文档**:这是项目...

    软件项目文档.rar

    《软件项目文档——全方位解析软件开发的规范与实践》 软件开发是一项系统性工程,它涉及到的需求分析、设计、编码、测试以及维护等环节都需要有严谨的文档支持。本资源"软件项目文档.rar"便是一个全面涵盖软件开发...

    软件开发文档模型

    "软件开发文档模型"是一个完整的框架,涵盖了从项目启动到最终交付的所有关键阶段的文档,确保了开发过程的规范性和可追溯性。 1. **操作手册**:操作手册是用户与软件交互的指南,它详细描述了软件的功能、操作...

Global site tag (gtag.js) - Google Analytics