GB/T 8567-2006《计算机软件文档编制规范》之 计算机编程手册(CPM)
说明:
1.《计算机编程手册》(CPM)提供了一个程序员理解如何在给定的计算机上编程所需的信息.本手册专注于计算机本身,而不是运行于计算机上的特定软件。
2.CPM主要针对新开发的计算机、特定用途的计算机、其他不能利用商用的或其他编程手册的计算机。
1引言
1.1标识
本条应包含本文档适用的计算机系统的制造商名、型号和其他的标识信息。
1.2计算机系统概述
本条应简述本文档适用的计算机系统的用途。
1.3文档概述
本条应概括本文档的用途和内容,并描述与其使用有关的保密性或私密性要求。
2引用文件
本章应列出本文档引用的所有文档的编号、标题、修订版本和日期。也应标识不能通过正常的供货渠道获得的所有文档的来源。
3编程环境
适当的话,本章应分条提供以下信息:
a.计算机系统的部件和配置;
b.操作特性、能力和限制,(若适用),包括:
1)机器时钟周期;
2)字长;
3)内存容量和特性;
4)指令集的特性;
5)中断能力;
6)操作方式(例如批处理、交互式、特权级、非特权级);
7)操作寄存器;
8)错误指示器;
9)输入/输出特性;
10)特殊特性。
c.在计算机系统上执行编译与汇编所需的设备(例如磁带、磁盘、其他外围设备)描述。(若适用)按名字与版本号标识编辑程序、连接程序、连接编辑程序、编译程序、汇编程序、交叉编译程序、交叉汇编程序和使用的其他实用程序。并引用描述它们的用法的相应手册。要着重强调如何加载、执行、记录结果所必需的特殊的标志或指令。
4编程信息
适当的话,本章应分条提供以下信息:
a.描述计算机指令集体系结构的编程特点。(若适用)包括:
1)数据表示(例如字节、字、整数、浮点数、双精度);
2)指令格式和寻址方式;
3)专用寄存器和字(例如堆栈指针、程序计数器);
4)控制指令(例如分支、跳转、子程序和过程调用指令、特权级指令和它们的操作方式);
5)子程序和过程(例如不可重人、可重人、宏代码例程、变元表、参数传递约定);
6)中断处理;
7)计时器与时钟;
8)内存保护特点(例如只读内存);
9)其他的特点,例如指令或数据的高速缓存的体系结构。
b.每一条指令的描述,(若适用),包括:
1)用法;
2)语法;
3)条件码集合;
4)执行时间;
5)机器码格式;
6)记忆码约定;
7)其他的特性。
c.输入/输出控制编程描述,(若适用),包括:
1)计算机内存的初始加载和校验;
2)串行和并行数据通道;
3)离散的输入、输出;
4)接口部件;
5)外围设备的设备号、操作码、内存单元。
d.与计算机系统有关的其他的、受限的或专用的编程技术(例如微程序控制节的简述);
e.说明上述的编程特点的实例,包括计算机系统各类指令正确用法的实例;
f.与计算机系统有关的错误检测与诊断功能,包括条件码、溢出和寻址异常中断、输入/输出错误状态指示器。
5注解
本章应包含有助于理解本文档的一般信息(例如背景信息、词汇表、原理)。本章应包含为理解本文档需要的术语和定义,所有缩略语和它们在文档中的含义的字母序列表。
附录
附录可用来提供那些为便于文档维护而单独出版的信息(例如图表、分类数据)。为便于处理,附录可单独装订成册。附录应按字母顺序(A,B等)编排。