---
name: 错误消息文档化规范
description: 为软件产生的错误消息、诊断消息及其他系统消息创建完整、结构化的用户文档。当软件具备错误或诊断消息功能，且需符合GJB 438B标准第5.7条要求时使用本技能。
---

# 错误消息文档化规范

## 何时使用
- 软件在运行过程中会产生错误消息、诊断消息或其他系统消息
- 需要满足GJB 438B标准中关于“5.7 消息条目”的文档要求
- 用户需要明确知道每条消息的含义及应对措施

## 执行步骤
1. **识别所有相关消息**：列出软件在完成用户功能过程中可能产生的全部消息，包括：
   - 错误消息
   - 诊断消息
   - 其他系统消息

2. **为每条消息提供完整信息**：确保包含以下四项内容：
   - 消息的完整文本或唯一标识符
   - 消息的清晰含义解释
   - 消息出现的根本原因分析
   - 用户应采取的具体纠正动作

3. **选择文档组织方式**：
   - 方式一：直接在需求规格说明的“5.7 消息条目”章节中完整列出所有消息及其信息
   - 方式二：引用专门附录（必须确保附录包含上述全部四项信息，且用户可无障碍访问）

4. **分类与排序**：按功能模块或消息严重程度对消息进行分类，便于用户快速定位。

5. **提供操作指南**：对于复杂的纠正动作，必须给出分步操作说明，而非仅描述性文字。

## 注意事项
- 不得仅提供消息代码而不解释含义
- 引用附录时，必须验证附录内容完整性与可访问性
- 所有纠正动作必须具体、可执行，避免模糊建议