📓用户指南

用户使用指南

GJB438C-DocSkill 详细操作指南

1. 概述

1.1 目标读者

  • 软件工程师
  • 系统分析师
  • 项目经理
  • 质量保证人员

1.2 前置条件

条件 说明
Claude Code 已安装 CLI 并登录
Python 3.10+ Skill 自动调用

2. 安装

1
claude plugin add CMoments/GJB438C-DocSkill

或在 Claude Code 对话中：

1
/plugin add CMoments/GJB438C-DocSkill

3. 使用方式

3.1 触发 Skill

在 Claude Code 对话中用自然语言描述需求：

[10] 软件需求规格说明书：

1
2
> 帮我按照438C模板生成一份软件需求规格说明书
> 项目名称是"XXX系统"，开发单位是"XX研究所"

[11] 软件设计说明书：

1
2
> 按照GJB 438C标准填写软件设计说明
> 项目是编译器系统，包含词法分析和语法分析模块
触发关键词 触发 Skill
438C 需求规格说明 SRS 软件需求 [10] SRS
概要设计 SDD 设计说明 概要设计说明 [11] SDD

3.2 工作流程

1
2
3
4
5
6
7
8
9
10
11
Step 1: 填写封面信息 (config.json)
    ├── project 部分：项目名称、简称、版本、单位、部门
    ├── document 部分：文档标识、标题、密级、阶段、日期
    └── content 部分：背景概述、范围、特性
Step 2: 填写章节内容 (project.json)
    ├── 各章节的 replacement_pattern + content
    ├── 表格数据（locator_rows + rows）
    └── 动态章节/CSCI（[11] 专属）
Step 3: 生成文档
    └── python scripts/main.py --template ... --config ... --project ... --output ...
Step 4: 在 Word 中打开并刷新目录

4. [10] SRS 详细操作

4.1 章节结构

章节 标题 内容类型
1 范围 标识、系统概述、文档概述
2 引用文档 引用的标准和规范（表格）
3 需求 状态方式、能力需求、接口需求等（含动态章节）
4 合格性规定 需求验证方法（表格）
5 需求可追踪性 正向/反向追踪矩阵（表格）
6 注释 术语和缩略语

4.2 动态章节

[10] 的第 3 章支持 4 类动态子章节：

父节 动态内容 说明
3.1 要求的状态和方式 可变数量的状态/方式子项
3.2 软件能力需求 可变数量的功能模块子项
3.3 软件外部接口需求 可变数量的外部接口子项
3.4 软件内部接口需求 可变数量的内部接口子项

Claude 会引导你确认子项列表，然后逐项填写内容。

4.3 嵌套子章节

3.10（计算机资源需求）包含固定的 4 个子章节：

1
2
3
4
5
3.10 计算机资源需求
├── 3.10.1 计算机硬件需求
├── 3.10.2 计算机硬件资源使用需求
├── 3.10.3 计算机软件需求
└── 3.10.4 计算机通信需求

5. [11] SDD 详细操作

5.1 章节结构

章节 标题 内容类型
1 范围 标识、系统概述、文档概述
2 引用文档 引用的标准和规范（表格）
3 系统设计决策 设计方案描述
4 系统体系结构设计 CSCI 块（核心）
5 需求可追踪性 正向/反向追踪矩阵（表格）
6 注释 术语定义

5.2 CSCI 结构

第 4 章使用 cscis 数组定义 CSCI 块，每个 CSCI 包含 9 个字段：

字段 说明
title CSCI 名称（如”编译控制 CSCI”）
overview CSCI 概述
component_title 部件名称
component_design 部件设计描述
execution_plan 执行方案
interface_overview 接口设计概述
interface_identification 接口标识和接口图
interface_detail_title 接口详细设计标题
interface_details 接口详细设计内容

引擎会自动克隆整个 CSCI 原型块，为每个 CSCI 生成完整的 4 级标题结构。

6. 输出与验证

6.1 生成结果

脚本执行成功后输出：

1
2
文档已生成: /path/to/output.docx
目录字段已标记为需要更新，首次在 Word 中打开时应刷新目录。

6.2 后续操作

首次在 Word 中打开生成的文档时：

  1. 按提示刷新目录（右键目录 → 更新域 → 更新整个目录）
  2. 检查页码是否正确
  3. 检查表格格式是否完整

6.3 错误排查

错误 原因 解决方案
StrictTemplateError 锚点未在模板中找到 检查模板文件是否完整
StrictDataError JSON 字段缺失或为空 检查 config.json/project.json 必填字段
命中数量不符 模板结构变化导致匹配异常 确认模板版本与 Skill 对应

7. 附录

7.1 术语表

术语 说明
SRS Software Requirements Specification，软件需求规格说明书
SDD Software Design Description，软件设计说明书
CSCI Computer Software Configuration Item，计算机软件配置项
GJB 国家军用标准
BuildPlan 构建计划，包含所有替换规则的不可变数据结构