51 lines
1.9 KiB
Markdown
51 lines
1.9 KiB
Markdown
|
---
|
|||
|
|
name: software-user-manual-creation
|
|||
|
|
description: 判断是否需要为用户可操作软件或带用户接口的CSCI编制独立的软件用户手册（SUM），并在需要时按规范生成完整SUM内容。当软件由用户直接运行且具有联机输入/输出接口时使用本技能；若为嵌入式软件且其内容已包含在系统手册中，则无需单独编制。
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
# 软件用户手册（SUM）编制规范
|
|||
|
|
|
|||
|
|
## 何时使用
|
|||
|
|
- 软件由最终用户直接运行
|
|||
|
|
- 软件具备用户接口，用于获取联机输入或解释输出显示
|
|||
|
|
- 需确认是否应编制独立SUM，或内容已合并至系统级手册
|
|||
|
|
|
|||
|
|
## 执行步骤
|
|||
|
|
|
|||
|
|
### 1. 判断编制条件
|
|||
|
|
**必须编制SUM的情况：**
|
|||
|
|
- 软件由用户直接运行
|
|||
|
|
- 具有用户接口用于联机输入或输出解释
|
|||
|
|
|
|||
|
|
**无需单独编制SUM的情况：**
|
|||
|
|
- 软件为硬件-软件系统中的嵌入式软件
|
|||
|
|
- 系统的用户手册或操作手册已完整包含SUM所需全部内容
|
|||
|
|
|
|||
|
|
### 2. 编制SUM核心内容
|
|||
|
|
确保SUM包含以下三部分：
|
|||
|
|
|
|||
|
|
#### a) 软件概述
|
|||
|
|
- 软件用途
|
|||
|
|
- 必需安装的软件文件清单
|
|||
|
|
- 软件运行环境（硬件、操作系统、依赖项等）
|
|||
|
|
- 软件组织结构与操作概览
|
|||
|
|
- 意外事故处理及备用状态/方式
|
|||
|
|
- 保密性要求
|
|||
|
|
- 帮助获取途径与问题报告机制
|
|||
|
|
|
|||
|
|
#### b) 软件入门
|
|||
|
|
- 普通用户所需的基本信息（如账号、权限、初始设置）
|
|||
|
|
- 启动、停止、挂起的标准规程
|
|||
|
|
|
|||
|
|
#### c) 使用指南
|
|||
|
|
- 功能能力说明与用户约定
|
|||
|
|
- 标准处理规程（含典型操作流程）
|
|||
|
|
- 数据备份与恢复方法
|
|||
|
|
- 系统消息含义解释
|
|||
|
|
- 错误、故障及紧急情况的恢复措施
|
|||
|
|
|
|||
|
|
### 3. 输出结果
|
|||
|
|
- 若需编制：生成符合附录Q格式要求的完整SUM文档
|
|||
|
|
- 若无需编制：输出声明，确认相关内容已合并至系统手册
|
|||
|
|
|
|||
|
|
> 注意：正文格式须严格遵循标准附录Q（资料性附录）要求。
|