commandby doccker

Requirement Doc

生成需求文档框架

Installs: 0
Used in: 1 repos
Updated: 2d ago
$npx ai-builder add command doccker/requirement-doc

Installs to .claude/commands/requirement-doc.md

根据以下信息,为「$ARGUMENTS」生成需求文档框架。

请按照以下模板结构生成,根据实际需求填充内容:

---

# [功能名称] 需求文档

作者:wwj
版本:v1.0
日期:[当前日期]
状态:草稿

---

## 一、背景

<!-- [注释] 简要描述业务背景、问题或机会 -->

[背景描述]

**所有改动仅对 [范围] 生效,不影响 [其他范围]。**

---

## 二、功能清单

| 序号 | 功能模块 | 功能点 | 优先级 |
|------|---------|-------|--------|
| 1 | [模块] | [功能点] | 高/中/低 |
| 2 | [模块] | [功能点] | 高/中/低 |

---

## 三、[模块1名称]

### 3.1 界面变化

| 变化项 | 原显示 | 新显示 |
|--------|-------|--------|
| [变化项] | [原] | [新] |

### 3.2 功能说明

**[功能名称]**

**触发条件**:[条件描述]

**输入/模板字段**:

| 字段名 | 是否必填 | 说明 |
|--------|---------|------|
| [字段] | 是/否 | [说明] |

**处理规则**:
- 规则1
- 规则2

---

## 四、[模块2名称]

### 4.1 界面术语变化

| 系统原显示 | 新显示 |
|-----------|--------|
| [原] | [新] |

### 4.2 新增字段

| 字段 | 说明 |
|------|------|
| [字段] | [说明] |

### 4.3 处理逻辑

```
[流程或规则描述]
```

**示例**:

| 输入 | 处理 | 输出 |
|------|------|------|
| [输入] | [处理] | [输出] |

---

## 五、业务流程

```
┌─────────────────────────────────────────┐
│              [流程名称]                   │
├─────────────────────────────────────────┤
│                                         │
│   第一步:[步骤名称]                       │
│   ┌─────────────────────────────────┐   │
│   │ 1. [操作1]                       │   │
│   │ 2. [操作2]                       │   │
│   └─────────────────────────────────┘   │
│                    ↓                     │
│   第二步:[步骤名称]                       │
│   ┌─────────────────────────────────┐   │
│   │ 1. [操作1]                       │   │
│   │ 2. [操作2]                       │   │
│   └─────────────────────────────────┘   │
│                                         │
└─────────────────────────────────────────┘
```

---

## 六、验收清单

### 6.1 [模块1]

- [ ] [验收点1]
- [ ] [验收点2]

### 6.2 [模块2]

- [ ] [验收点1]
- [ ] [验收点2]

### 6.3 约束条件

- [ ] [约束1,如"仅对XX生效"]
- [ ] [约束2,如"不影响其他XX"]

---

## 七、非功能需求(如需要)

| 需求类型 | 要求 |
|---------|------|
| 性能 | [要求] |
| 兼容性 | [要求] |
| 安全性 | [要求] |

---

**文档版本历史**

| 版本 | 日期 | 作者 | 说明 |
|------|------|------|------|
| v1.0 | [日期] | wwj | 初稿 |

Quick Install

$npx ai-builder add command doccker/requirement-doc

Details

Type
command
Author
doccker
Slug
doccker/requirement-doc
Created
5d ago