GB/T 8567-2006 "Computer Software Documentation Specification" Computer Operation Manual (COM)

illustrate:

1. The Computer Operator's Manual (COM) provides information necessary to operate the specified computer and its peripherals. This manual focuses on the computer itself, not the specific software running on it

2.COM is mainly aimed at some newly developed computers, special-purpose computers, and other computers without ready-made commercial operation manuals or other operation manuals.

 

 

 

 

 

1 Introduction

1.1 Identification

This paragraph shall contain the manufacturer's name, model number, and other identifying information of the computer system to which this document applies.

1.2 Overview of Computer Systems

This paragraph should briefly describe the purpose of the computer system to which this document applies.

1.3 Documentation overview

This paragraph shall outline the purpose and content of this document and describe the confidentiality or privacy requirements associated with its use.

2 Reference documents

This chapter should list the numbers, titles, revisions, and dates of all documents referenced in this document. The source of all documentation not available through normal supply channels should also be identified.

3 computer system operation

This chapter should be divided into the following sections. Safety precautions marked with a "WARNING" or "CAUTION" should be included where appropriate.

3.1 Preparation and shutdown of the computer system

This article shall be divided into the following articles.

3.1.1 Power up and down

This paragraph shall contain the necessary procedures for powering up and powering down computer systems.

3.1.2 Startup process

This paragraph shall contain the steps necessary to start the operation of the computer system ( if applicable ) , including the typical commands for powering up the equipment, preparing for operation, self-testing and starting the computer system.

3.1.3 Shutdown

本条应包含终止计算机系统操作的必要规程。

3.2操作过程

本条应分为以下几条。如果有多种操作方式,应为每一种方式提供相应的说明。

3.2.1输入和输出过程

本条应描述与计算机系统有关的输入和输出媒体(例如磁盘、磁带),描述在这些媒体上的读写过程,简述操作系统的控制语言,并列出交互消息和响应过程(例如使用的终端、口令、键)

3.2.2监视过程

本条应包含监视计算机系统的操作所应遵循的过程。它应描述可用的指示器,对这些指示器的解释和必须遵循的规程及专用监视过程。

3.2.3脱机过程

本条应包含操作所有与计算机系统有关的脱机设备的必须的过程。

3.2.4其他过程

本条应包含操作员要遵循的任何附加的过程(例如计算机系统报警、计算机系统保密性或私密性要求、切换到冗余的计算机系统,或在紧急情况下保证操作连续性的其他措施。)

3.3问题处理过程

本条应标识在第3章前几条中所描述的操作步骤中可能发生的问题。它应陈述错误消息或与该问题相关的其他指示信息,并应描述针对每一发生的问题要遵循的自动和手工的过程(若适用),包括评价技术、要求关闭计算机系统的条件、联机干预或非正常退出的过程、在操作中断或非正常退出后采取的重新启动计算机系统操作的步骤,以及记录有关故障的过程。

4诊断功能

本章应分为以下几条描述为标识和定位计算机系统内的故障而可能采取的诊断措施。

4.1诊断功能综述

本条应概述计算机系统的诊断功能。包括错误消息语法和故障隔离的层次结构。本条应描述每一个诊断功能的目的。

4.2诊断过程

本条应分为以下几条描述计算机系统要遵循的诊断过程,包括:

a.执行每一诊断过程需要的硬件、软件或固件的标识;

b.执行每一诊断过程的分步指令;

c.诊断消息和相应的要求动作。

4.3诊断工具

本条应分为以下几条描述计算机系统可用的诊断工具。这些工具可能是硬件、软件或固件。本条应用名字和编号来标识每一个工具,并描述这种工具和它的应用。

5注解

本章应包含有助于理解本文档的一般信息(例如背景信息、词汇表、原理说明)。本章应包含为理解本文档需要的术语和定义,所有缩略语和它们在文档中的含义的字母序列。

附录

附录可用来提供那些为便于文档维护而单独出版的信息(例如图表、分类数据)。为便于处理,附录可单独装订成册。附录应按字母顺序(AB)编排。

Guess you like

Origin http://10.200.1.11:23101/article/api/json?id=326647345&siteId=291194637