51 lines
2.4 KiB
Markdown
51 lines
2.4 KiB
Markdown
|
---
|
||
|
|
name: 编写标准化数据库设计说明文档结构
|
||
|
|
description: 当需要编写正式的数据库设计说明文档时使用本技能。适用于数据库设计文档、数据管理系统或软件数据组件的开发场景，不适用于简单配置文件或临时数据存储。该技能提供符合行业标准的结构化章节框架，确保覆盖范围、设计决策、详细设计、可追踪性等关键内容。
|
||
|
|
---
|
||
|
|
|
||
|
|
# 编写标准化数据库设计说明文档结构
|
||
|
|
|
||
|
|
在以下情况下应用本技能：
|
||
|
|
- 存在明确的数据库设计需求
|
||
|
|
- 需要产出正式、可审计的数据库设计文档
|
||
|
|
- 文档需支持系统级需求追溯与团队协作
|
||
|
|
|
||
|
|
## 执行步骤
|
||
|
|
|
||
|
|
1. **范围章节**
|
||
|
|
- 提供文档标识（如版本、作者、日期）
|
||
|
|
- 概述数据库用途与目标
|
||
|
|
- 描述本文档的结构与目的
|
||
|
|
|
||
|
|
2. **引用文档章节**
|
||
|
|
- 列出所有规范性引用文档（如需求规格说明书、系统架构文档）
|
||
|
|
- 注明非正式或非标准来源（如有）
|
||
|
|
|
||
|
|
3. **数据库级设计决策章节**
|
||
|
|
按以下子项逐一说明高层设计选择：
|
||
|
|
- 输入输出设计决策
|
||
|
|
- 响应行为设计决策
|
||
|
|
- 数据呈现方式设计决策
|
||
|
|
- DBMS选型及未来灵活性考量
|
||
|
|
- 可用性、安全性、保密性、连续性等级设计
|
||
|
|
- 分布式架构决策（如客户/服务器模型、数据同步策略、一致性机制）
|
||
|
|
- 备份与恢复策略
|
||
|
|
- 重组、排序、索引及同步机制设计
|
||
|
|
|
||
|
|
4. **数据库详细设计章节**
|
||
|
|
按设计级别（概念、逻辑、物理、内部）分层描述：
|
||
|
|
- **数据元素特征**：包括标识符、数据类型、格式、取值约束、默认值等
|
||
|
|
- **数据元素组合体特征**：描述表、记录等结构化实体的组成、关系（如主外键）、完整性约束等
|
||
|
|
|
||
|
|
5. **数据库访问/操纵软件单元详细设计章节**
|
||
|
|
- 说明用于操作数据库的程序模块、API 或脚本的设计细节
|
||
|
|
- 包括接口参数、调用方式、错误处理等
|
||
|
|
|
||
|
|
6. **需求可追踪性章节**
|
||
|
|
- 建立数据库设计项与系统/CSCI需求之间的双向追溯矩阵
|
||
|
|
- 确保每个设计决策均可回溯至原始需求
|
||
|
|
|
||
|
|
7. **注释章节**
|
||
|
|
- 提供背景信息、术语定义、缩略语表或关键公式说明
|
||
|
|
|
||
|
|
> **注意**：使用“数据元素”指代字段或属性（无结构），使用“数据元素组合体”指代表、记录等有结构的实体。
|