139 lines
2.2 KiB
Markdown
139 lines
2.2 KiB
Markdown
|
|
# {{PROJECT_NAME}} - 需求文档
|
||
|
|
|
||
|
|
**文档版本**: 1.0
|
||
|
|
**创建时间**: {{CREATED_DATE}}
|
||
|
|
**生成方式**: Claude Code 智能需求生成器
|
||
|
|
**项目类型**: Agent 开发
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 1. 背景与目标
|
||
|
|
|
||
|
|
### 1.1 项目背景
|
||
|
|
{{BACKGROUND}}
|
||
|
|
|
||
|
|
### 1.2 目标与价值
|
||
|
|
{{OBJECTIVES_AND_VALUE}}
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 2. 使用场景与触发方式
|
||
|
|
|
||
|
|
### 2.1 典型使用场景
|
||
|
|
{{SCENARIOS}}
|
||
|
|
|
||
|
|
### 2.2 使用入口与触发方式
|
||
|
|
{{ENTRY_METHODS}}
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 3. 输入输出定义
|
||
|
|
|
||
|
|
### 3.1 输入
|
||
|
|
{{INPUT_DEFINITION}}
|
||
|
|
|
||
|
|
### 3.2 输出
|
||
|
|
{{OUTPUT_DEFINITION}}
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 4. 交互流程说明
|
||
|
|
|
||
|
|
### 4.1 典型主流程
|
||
|
|
|
||
|
|
{{MAIN_WORKFLOW}}
|
||
|
|
|
||
|
|
> 建议使用 Mermaid 流程图展示:
|
||
|
|
> ```mermaid
|
||
|
|
> flowchart TD
|
||
|
|
> Start([开始]) --> Step1[步骤1]
|
||
|
|
> Step1 --> Step2[步骤2]
|
||
|
|
> Step2 --> End([结束])
|
||
|
|
> ```
|
||
|
|
|
||
|
|
### 4.2 异常与分支流程
|
||
|
|
|
||
|
|
{{EXCEPTION_AND_BRANCH_FLOWS}}
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 5. 外部系统与数据依赖
|
||
|
|
|
||
|
|
### 5.1 外部数据源需求
|
||
|
|
{{DATA_ACCESS_REQUIREMENTS}}
|
||
|
|
|
||
|
|
### 5.2 系统集成需求
|
||
|
|
{{SYSTEM_INTEGRATION}}
|
||
|
|
|
||
|
|
### 5.3 数据交互时序
|
||
|
|
{{DATA_FLOW_SEQUENCE}}
|
||
|
|
|
||
|
|
> 建议使用 Mermaid 序列图展示数据在各系统间的流转:
|
||
|
|
> ```mermaid
|
||
|
|
> sequenceDiagram
|
||
|
|
> participant U as 用户
|
||
|
|
> participant A as Agent
|
||
|
|
> participant D as 数据库
|
||
|
|
> participant E as 外部API
|
||
|
|
>
|
||
|
|
> U->>A: 发起请求
|
||
|
|
> A->>D: 查询数据
|
||
|
|
> D-->>A: 返回结果
|
||
|
|
> A->>E: 调用外部服务
|
||
|
|
> E-->>A: 返回响应
|
||
|
|
> A-->>U: 展示最终结果
|
||
|
|
> ```
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 6. 系统模块与Agent角色定义
|
||
|
|
|
||
|
|
### 6.1 Agent列表与核心职能
|
||
|
|
{{ROLE_CORE_FUNCTIONS}}
|
||
|
|
|
||
|
|
### 6.2 Agent能力边界
|
||
|
|
{{CAPABILITY_BOUNDARIES}}
|
||
|
|
|
||
|
|
### 6.3 Agent间协作关系
|
||
|
|
{{AGENT_INTERACTIONS}}
|
||
|
|
|
||
|
|
> 建议使用 Mermaid 图展示 Agent 间的调用关系:
|
||
|
|
> ```mermaid
|
||
|
|
> flowchart LR
|
||
|
|
> Main[主Agent] --> Sub1[子Agent1]
|
||
|
|
> Main --> Sub2[子Agent2]
|
||
|
|
> Sub1 --> Sub3[子Agent3]
|
||
|
|
> ```
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 7. 分阶段交付计划
|
||
|
|
|
||
|
|
{{PHASES}}
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 8. 技术约束与非功能性需求
|
||
|
|
|
||
|
|
### 8.1 技术约束
|
||
|
|
{{TECH_CONSTRAINTS}}
|
||
|
|
|
||
|
|
### 8.2 性能要求
|
||
|
|
{{PERFORMANCE_REQUIREMENTS}}
|
||
|
|
|
||
|
|
### 8.3 安全要求
|
||
|
|
{{SECURITY_REQUIREMENTS}}
|
||
|
|
|
||
|
|
### 8.4 其他非功能性要求
|
||
|
|
{{OTHER_REQUIREMENTS}}
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 9. 验收标准
|
||
|
|
|
||
|
|
### 9.1 功能验收标准
|
||
|
|
{{FUNCTIONAL_ACCEPTANCE}}
|
||
|
|
|
||
|
|
### 9.2 非功能验收标准
|
||
|
|
{{NON_FUNCTIONAL_ACCEPTANCE}}
|