如何写维护手册

Question

第一把系统的主要功能述说
第二操作步骤
第三界面的友好性

Answer 1

主要是要说清思路，完成任务的流程，另外，如果程序改了，说明文档一定要及时跟上。

Answer 2

功能，操作，注意事项，重要的是有图片

Answer 3

我要的是维护手册,又不是功能介绍

Answer 4

偶写过技术手册和用户手册，
就是没有写过维护手册。

Answer 5

文档编号 
版 本 号 
密    级  
文档名称                XXXX程序维护手册项目编号：                         
项目名称： 
开发部门： 
项目负责人： 编写    年  月  日
校对    年  月  日
审核    年  月  日
批准    年  月 日   
程序维护手册
1引言
1．1  编写目的
       [ 阐明编写维护手册的目的，简述其内容。指出读者对象（程序维护人员、研发人员）。]
1．2  开发单位
       [说明项目的提出者、项目的委托单位、开发单位和使用场所。]
1．3  定义
       [ 列出本文挡中用到的专业术语的定义和缩写词的原文。]
1．4  参考资料
       [ 可包括：a.用户操作手册；b.于本项目有关的文档。列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源以及保密级别。]
2 系统说明
2．1  系统用途
       [ 说明系统具备的功能，输入和输出。]
2．2  安全保密
       [ 说明系统安全保密方面的考虑。]
2．3  总体说明
      [ 说明系统的总体功能、对子系统和作业作出综合性的介绍，并用图表方式给出系统主要部分的内部关系。]
2．4  程序说明
      [ 说明系统中每一程序、分程序的细节和特性。]
2．4．1 程序1的说明
2．4．1．1  功能 [ 说明程序的功能。]
2．4．1．2  方法 [ 说明实现方法。]
2．4．1．3  输入 [ 说明程序的输入、媒体、运行数据记录、运行开始时使用的输入数据的类型和存放单元、与程序初始化有关的入口要求。]
2．4．1．4  处理 [ 处理特点和目的，如：a. 用图表说明程序的运行的逻辑流程; b. 程序主要转移条件；c. 对程序的约束条件；d. 程序结束时的出口要求；e.与下一个程序的通信与联结（运行、控制）; f. 由该程序产生并供处理使用的输出数据类型和存放单元。g.程序运行所用存储量、类型及存储位置等。]
2．4．1．5 输出 [ 程序的输出。]
2．4．1．6  接口 [ 本程序与本系统其他部分的接口。]
2．4．1．7  表格 [ 说明程序内部的各种表、项的细节和特性。对每张表的说明至少包括：a. 表的标识符；b. 使用目的；c. 使用此表的其他程序；d. 逻辑划分，如块或部，不包括表项；e. 表的基本结构；f. 设计安排，包括表的控制信息。表目结构细节、使用中的特有性质及各表项的标识、位置、用途、类型、编码表示。]
2．4．1．8  特有的运行性质 [ 说明在用户操作手册中没有提到的运行性质。]
2．4．2 程序2 的说明 [ 与程序1 的说明相同。以后其他各程序的说明相同。]
3 操作环境
3．1  设备
       [ 逐步说明系统的设备配置极其特性 ]
3．2  支持文件
       [ 列出系统使用的支持软件、包括他们的名称和版本号。]
3．3  数据库
       [ 说明每个数据库的性质和内容，包括安全考虑。]
3．3．1 总体特征
  [ 如：a. 标识符 b. 使用这些数据库的程序；c. 静态数据；d. 动态数据；e. 数据库的存储媒体；f. 程序使用数据库的限制。]
3．3．2 结构及详细说明
3．3．2．1  说明该数据库的结构，包括其中的记录和项；
3．3．2．2  说明记录的组成，包括首部或或控制段、记录体；
3．3．2．3  说明每个记录结构的字段，包括：标记或标号、字段的字符长度和位数该字段的允许值范围。
3．3．2．4  扩充：说明为记录追加字段的规定；
4 维护过程
4．1  约定
      [ 列出该软件系统设计中所使用全部规则和约定，包括：a. 程序、分程序、记录、字段和存储区的标识或标号助记符的使用规则；b. 图表的处理标准、卡片的连接顺序、语句和记号中使用的缩写、出现在图表中的符号名；c. 使用软件的技术标准；d. 标准化的数据元素极其特征。]
4．2  验证过程
      [ 说明一个程序修改后，对其进行验证的要求和过程（包括测试程序和数据）及程序周期性验证的过程。]
4．3  出错及纠正方法
      [ 列出出错状态及其纠正方法。]
4．4  专门维护过程
      [ 说明文档其他地方没有提到的专门维护过程，如：a. 维护该软件系统的输入部分（如数据库）的要求、过程和验证方法；b. 运行程序库维护系统所必须的要求、过程和验证方法；c. 对闰年、世纪变更所需要的临时性修改等。]
4．5  专用维护程序
      [ 列出维护软件系统使用的后备技术和专用程序（如文件恢复程序、淘汰过时文件的程序等）的目录，并加以说明，内容包括：a. 维护作业的输入输出要求；b. 输入的详细过程及硬件设备上建立、运行并完成维护作业的操作步骤。]
4．6  程序清单和流程图
       [ 引用资料或提供附录给出程序清单和流程图。]