requirements-analysis/docs/USAGE.md

简化的需求分析MCP服务 - 基于AI软件工程（优化版）6步流程

# 📖 使用指南

## 🚀 快速开始

### 1. 启动服务

```bash
cd requirements-analysis-simple
npm install
npm run build
npm start
```

### 2. Claude Desktop 集成

在 Claude Desktop 配置文件中添加：

```json
{
  "mcpServers": {
    "requirements-analysis-simple": {
      "command": "node",
      "args": ["path/to/requirements-analysis-simple/dist/index.js"]
    }
  }
}
```

## 🎯 完整使用流程

### Step 1: 启动需求分析

在 Claude Desktop 中输入：

```
请帮我进行需求分析，项目信息如下：
- 项目名称：智能客服系统
- 项目类型：new
- 所属行业：金融科技
- 项目背景：当前客服响应时间过长，客户满意度下降，人工成本高昂，需要智能化客服系统提升服务效率和用户体验
- 核心目标：提升客服响应速度50%，降低人工成本30万/年，客户满意度提升至95%以上，支持7x24小时服务
- 项目预算：100-150万
- 项目周期：6个月
- 团队规模：8人团队
- 部署要求：cloud
- 特殊要求：需要支持多语言，集成现有CRM系统
```

### Step 2-6: 执行6步流程

系统会自动引导你完成以下步骤：

1. **第1步：项目基础信息填写** (5分钟)
   - 验证项目信息完整性
   - 标准化项目描述
   - 评估可行性

2. **第2步：AI智能分析项目全貌** (10分钟)
   - 行业背景分析
   - 用户需求分析
   - 技术环境分析
   - 功能规划建议

3. **第3步：生成需求分析文档初版** (10分钟)
   - 完整的需求分析文档
   - 功能需求和非功能需求
   - 验收标准

4. **第4步：AI质量分析** (8分钟)
   - 5维度质量评分
   - 问题识别
   - 改进建议概要

5. **第5步：生成改进建议** (5分钟)
   - 详细的改进建议
   - 优先级分类
   - 实施计划

6. **第6步：生成最终文档** (10分钟)
   - 改进后的最终需求文档
   - 改进说明
   - 质量保证

## 📁 输出文档

每个项目会在 `outputs/[项目名称]/` 目录下生成：

```
outputs/智能客服系统/
├── README.md                 # 项目摘要
├── step1-项目信息.md         # 第1步结果
├── step2-AI分析.md           # 第2步结果
├── step3-需求文档初版.md     # 第3步结果
├── step4-质量分析.md         # 第4步结果
├── step5-改进建议.md         # 第5步结果
└── step6-最终文档.md         # 第6步结果（最终版）
```

## 🛠️ MCP工具说明

### start_requirements_analysis
启动需求分析流程

**参数**：
- `projectName` (必填): 项目名称
- `projectType` (必填): 项目类型 (new/upgrade/integration/other)
- `industry` (必填): 所属行业
- `background` (必填): 项目背景
- `objectives` (必填): 核心目标
- `budget` (可选): 项目预算
- `timeline` (可选): 项目周期
- `teamSize` (可选): 团队规模
- `deployment` (可选): 部署要求 (cloud/onpremise/hybrid)
- `specialRequirements` (可选): 特殊要求

### execute_step
执行指定步骤

**参数**：
- `sessionId`: 会话ID
- `stepNumber`: 步骤编号 (1-6)
- `result`: AI执行的步骤结果

### get_step_result
获取指定步骤的结果

**参数**：
- `sessionId`: 会话ID
- `stepNumber`: 步骤编号 (1-6)

### list_projects
列出所有项目

### get_project_summary
获取项目摘要

**参数**：
- `sessionId`: 会话ID

## 📊 质量标准

### 最终文档质量目标
- **目标得分**: 97分
- **完整性**: 95%以上
- **准确性**: 高
- **一致性**: 高
- **可用性**: 高
- **格式规范**: 100%

### 验收标准
- 所有功能需求使用BDD格式
- 需求ID格式：REQ-[模块]-[序号]
- 优先级标记：P0/P1/P2
- 文档结构完整
- 内容逻辑清晰

## 🔧 故障排查

### 常见问题

1. **参数验证失败**
   - 检查必填参数是否完整
   - 确认参数格式正确

2. **服务启动失败**
   - 检查Node.js版本 (需要18+)
   - 确认依赖安装完整

3. **文档保存失败**
   - 检查输出目录权限
   - 确认磁盘空间充足

### 调试模式

查看详细日志：
```bash
DEBUG=* node dist/index.js
```

## 💡 最佳实践

1. **项目信息准备**
   - 背景描述至少20字符
   - 目标尽量量化
   - 提供完整的约束条件

2. **步骤执行**
   - 按顺序执行6个步骤
   - 每步结果要充实完整
   - 及时保存中间结果

3. **文档管理**
   - 定期备份输出文档
   - 建立版本管理机制
   - 及时更新项目摘要

## 🎯 预期效果

- **总用时**: 48分钟
- **质量提升**: 从初版89分提升到最终97分
- **自动化程度**: 90%以上工作由AI完成
- **最终产出**: 可直接用于产品设计的高质量需求分析文档

---

**设计理念**: 化繁为简，专注核心价值，让AI软件工程的需求分析流程更加简洁高效。