43 lines
1.8 KiB
Markdown
43 lines
1.8 KiB
Markdown
|
---
|
|||
|
|
name: 软件设计说明结构要求
|
|||
|
|
description: 本技能提供符合军用标准的软件设计说明文档（包括CSCI设计文档）的标准结构模板。当用户需要编写或审查软件设计说明文档，且已具备需求规格说明并进入详细设计阶段（非概念设计阶段）时，应使用此技能。
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
# 软件设计说明结构要求
|
|||
|
|
|
|||
|
|
## 适用条件
|
|||
|
|
- 已完成需求规格说明
|
|||
|
|
- 正在进行软件详细设计（不适用于概念设计阶段）
|
|||
|
|
- 编写对象为软件设计说明文档或CSCI设计文档
|
|||
|
|
|
|||
|
|
## 执行步骤
|
|||
|
|
|
|||
|
|
1. **范围章节**
|
|||
|
|
- 包含文档标识、系统概述、文档概述
|
|||
|
|
|
|||
|
|
2. **引用文档章节**
|
|||
|
|
- 列出所有被引用的标准、规范和文档
|
|||
|
|
|
|||
|
|
3. **CSCI级设计决策章节**
|
|||
|
|
- 描述影响软件单元选择与设计的关键决策，包括：
|
|||
|
|
a) 输入输出设计决策
|
|||
|
|
b) 响应行为设计决策
|
|||
|
|
c) 数据库/数据文件呈现决策
|
|||
|
|
d) 安全性和保密性方法
|
|||
|
|
e) 其他CSCI级设计决策
|
|||
|
|
|
|||
|
|
4. **CSCI体系结构设计章节**
|
|||
|
|
- a) **CSCI部件**：描述所有软件单元（如类、模块、函数、数据库等）、静态关系、用途、开发状态、资源使用及库位置
|
|||
|
|
- b) **执行方案**：说明软件单元间的动态关系，包括控制流程、数据流、状态转换等
|
|||
|
|
- c) **接口设计**：按接口标识符逐一描述接口特性
|
|||
|
|
|
|||
|
|
5. **CSCI详细设计章节**
|
|||
|
|
- 按软件单元标识符分条目详细描述每个单元的设计实现
|
|||
|
|
|
|||
|
|
6. **需求可追踪性章节**
|
|||
|
|
- 建立软件单元与CSCI需求之间的双向可追踪性矩阵
|
|||
|
|
|
|||
|
|
7. **注释章节**
|
|||
|
|
- 包含背景信息、术语表、缩略语解释或必要公式
|
|||
|
|
|
|||
|
|
> 提示：确保每个章节内容聚焦于设计而非需求；设计决策应明确说明“为什么这样设计”而非仅描述功能。
|