TemplateProject/docs/features/index.md
2026-05-21 20:32:32 +08:00

1.0 KiB
Raw Blame History

docs/features — 功能规格说明

每个功能模块对应一个功能规格说明文档,用于描述该功能的完整定义。

文件命名

<功能名称>.md

功能规格模板

# [功能名称]

- **版本**v[版本号]
- **状态**:规划中 / 开发中 / 已完成
- **负责人**[姓名]
- **关联需求**[需求编号或链接]

## 1. 功能概述

> 一句话描述 + 详细说明(用户视角,这个功能能做什么、解决什么问题)。

## 2. 用户场景

- 作为 [角色],我希望 [做什么],以便 [达到什么目的]

## 3. 功能详情

### 3.1 前置条件

### 3.2 主流程

### 3.3 异常处理

- 异常情况 1[描述] → [预期行为]
- 异常情况 2[描述] → [预期行为]

## 4. 验收标准

- [ ] 标准 1
- [ ] 标准 2
- [ ] 标准 3

## 5. 约束与限制

- 性能要求
- 兼容性要求
- 其他限制

## 6. 关联

- 设计方案:`docs/design/technical/<相关方案>.md`
- 任务拆分:`docs/implementation/tasks/<相关任务>.md`