控制工程师论坛

教程与手册

程序维护手册格式说明

xilinxue
xilinxue

2008-11-05

文档编号

版 本 号

   

 

 

文档名称                XXXX程序维护手册

 

项目编号:                        

项目名称:

开发部门:

项目负责人:

 

编写       

校对       

审核       

批准      月 日

 

 

 

程序维护手册

1引言

11  编写目的

       [ 阐明编写维护手册的目的,简述其内容。指出读者对象(程序维护人员、研发人员)。]

 

12  开发单位

       [说明项目的提出者、项目的委托单位、开发单位和使用场所。]

 

13  定义

       [ 列出本文挡中用到的专业术语的定义和缩写词的原文。]

 

14  参考资料

       [ 可包括:a.用户操作手册;b.于本项目有关的文档。列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源以及保密级别。]

 

2 系统说明

21  系统用途

       [ 说明系统具备的功能,输入和输出。]

 

22  安全保密

       [ 说明系统安全保密方面的考虑。]

 

23  总体说明

      [ 说明系统的总体功能、对子系统和作业作出综合性的介绍,并用图表方式给出系统主要部分的内部关系。]

 

24  程序说明

      [ 说明系统中每一程序、分程序的细节和特性。]

241 程序1的说明

2411  功能 [ 说明程序的功能。]

2412  方法 [ 说明实现方法。]

2413  输入 [ 说明程序的输入、媒体、运行数据记录、运行开始时使用的输入数据的类型和存放单元、与程序初始化有关的入口要求。]

2414  处理 [ 处理特点和目的,如:a. 用图表说明程序的运行的逻辑流程; b. 程序主要转移条件;c. 对程序的约束条件;d. 程序结束时的出口要求;e.与下一个程序的通信与联结(运行、控制); f. 由该程序产生并供处理使用的输出数据类型和存放单元。g.程序运行所用存储量、类型及存储位置等。]

2415 输出 [ 程序的输出。]

2416  接口 [ 本程序与本系统其他部分的接口。]

2417  表格 [ 说明程序内部的各种表、项的细节和特性。对每张表的说明至少包括:a. 表的标识符;b. 使用目的;c. 使用此表的其他程序;d. 逻辑划分,如块或部,不包括表项;e. 表的基本结构;f. 设计安排,包括表的控制信息。表目结构细节、使用中的特有性质及各表项的标识、位置、用途、类型、编码表示。]

2418  特有的运行性质 [ 说明在用户操作手册中没有提到的运行性质。]

242 程序2 的说明 [ 与程序1 的说明相同。以后其他各程序的说明相同。]

回帖

评论2

总共 , 当前 /
首页 | 登录 | 注册 | 返回顶部↑
手机版 | 电脑版
版权所有 Copyright(C) 2016 CE China