2.1 KiB
2.1 KiB
name, description
| name | description |
|---|---|
| GJB438C军用软件文档结构规范 | 本技能用于指导编制符合GJB438C标准的军用软件文档时，正确构建其组成结构。当用户需要创建、审核或修改任何GJB438C规定的军用软件文档（如软件需求规格说明、设计文档等）时，应使用此技能确保封面、修改页、目录、正文和附录等组成部分完整且格式合规。 |
GJB438C军用软件文档结构规范
何时使用
- 编制、修订或审查任何依据GJB438C标准要求的军用软件文档时
- 文档类型包括但不限于软件开发计划、软件需求规格说明、软件设计说明、测试文档等
- 处理传统纸质文档或数据库等非传统格式文档时
执行步骤
1. 确保包含以下五个核心组成部分：
a) 封面
- 包含：文档号、版本/修订号、密级、文档名称、适用系统标识、编制单位
- 列出编写人、审核人、会签人、批准人及编制日期
b) 修改页
- 记录每次修改的历史信息
- 每条记录需包含：修改原因、修改内容、对应版本号、修改日期
c) 目录
- 列出所有章、条、附录、图表的编号、标题及对应页码
- 确保层级清晰、编号连续
d) 正文
- 按GJB438C第5章规定填充具体文档内容
- 内容必须与文档类型匹配（如需求、设计、测试等）
e) 附录
- 提供便于维护的独立信息（如大型表格、分类数据、示意图等）
- 每个附录必须在正文中被明确引用
2. 非传统格式文档（如数据库）的等效处理：
- 封面信息可嵌入外部元数据或内部标记字段中
- 目录可用指针列表或访问命令目录替代
- 页号可用唯一名称或逻辑编号代替，确保可检索性
3. 页号编排规则：
- 正文前页（封面至目录）：使用小写罗马数字（i, ii, iii…）
- 正文及附录：使用阿拉伯数字（1, 2, 3…）
- 多卷文档：每卷独立重新编号，不跨卷连续
注意：所有结构要求必须严格遵循GJB438C第4.3条款。