基于 OpenClaw + Claude Code 的智能文档协作平台,实现从需求到 PRD 设计的自动化与人机协同
| 分析类型 | 描述 | 适用场景 |
|---|---|---|
| improve | 改进建议 - 优化文档质量和完整性 | 初稿完成后提升文档质量 |
| expand | 内容扩展 - 添加更多细节和场景 | 需要补充边界情况和异常处理 |
| summarize | 生成摘要 - 创建执行摘要 | 为管理层准备简洁概述 |
| check_consistency | 一致性检查 - 发现矛盾和不一致 | 提交前最终审查 |
| 方法 | 路径 | 描述 |
|---|---|---|
| POST | /api/prd |
创建新的 PRD 文档 |
| GET | /api/prd/{id} |
获取指定 PRD 文档 |
| PUT | /api/prd/{id} |
更新 PRD 文档(自动创建版本) |
| POST | /api/prd/{id}/ai/analyze |
AI 分析文档并生成建议 |
| GET | /api/prd/{id}/suggestions |
获取所有 AI 建议 |
| POST | /api/prd/{id}/suggestions/{id}/review |
审核 AI 建议(接受/拒绝) |
| GET | /api/prd/{id}/versions |
获取文档所有版本 |
| GET | /api/prd/{id}/diff/{old}/{new} |
版本差异对比 |
| POST | /api/prd/{id}/comments |
添加评论 |
| WS | /ws/collaborate/{id}/{user} |
WebSocket 实时协作 |
import httpx
import asyncio
async def create_and_analyze_prd():
async with httpx.AsyncClient() as client:
# 1. 创建 PRD 文档
prd_data = {
"title": "用户管理系统",
"content": """
# 产品需求文档
## 1. 产品概述
构建一个完整的用户管理系统,支持注册、登录、权限管理等功能。
## 2. 核心功能
- 用户注册与登录
- 角色权限管理
- 个人资料管理
""",
"structured_data": {
"priority": "high",
"estimated_days": 30
}
}
response = await client.post(
"http://localhost:8000/api/prd",
json=prd_data
)
prd = response.json()
print(f"✅ PRD 创建成功,ID: {prd['id']}")
# 2. 请求 AI 分析
analysis_request = {
"document_id": prd['id'],
"analysis_type": "improve",
"instructions": "重点关注安全性和可扩展性"
}
analysis_response = await client.post(
f"http://localhost:8000/api/prd/{prd['id']}/ai/analyze",
json=analysis_request
)
result = analysis_response.json()
print(f"🤖 AI 生成了 {len(result['suggestions'])} 条建议:")
for suggestion in result['suggestions']:
print(f"\n💡 {suggestion['suggested_content']}")
print(f" 理由:{suggestion['reasoning']}")
# 3. 接受建议
if result['suggestions']:
review_response = await client.post(
f"http://localhost:8000/api/prd/{prd['id']}/suggestions/{result['suggestions'][0]['id']}/review",
json={"accept": True}
)
print("✅ 已接受第一条建议")
asyncio.run(create_and_analyze_prd())
# 1. 进入项目目录
cd prd_collaborative_system/backend
# 2. 安装依赖
pip install -r requirements.txt
# 3. 配置环境变量(可选)
cp .env.example .env
# 编辑 .env 添加 CLAUDE_API_KEY
# 4. 启动服务
python main.py
# 或使用 uvicorn
uvicorn main:app --host 0.0.0.0 --port 8000 --reload
# 5. 访问应用
# 浏览器打开:http://localhost:8000