304 lines
10 KiB
Markdown
304 lines
10 KiB
Markdown
|
||
---
|
||
|
||
# 🧠 ColaFlow 项目计划书
|
||
|
||
**版本：** 1.0 Draft
|
||
**作者：** Yaojia Wang / Colacoder 团队
|
||
**日期：** 2025-11
|
||
**用途：** 内部立项 & 技术实现规划
|
||
|
||
---
|
||
|
||
## 一、项目简介
|
||
|
||
**ColaFlow** 是一款基于 **AI + MCP 协议** 的新一代项目管理系统，灵感源自 Jira 的敏捷管理模式，但更智能、更开放、更流畅。
|
||
|
||
目标是让 **AI 成为团队成员**，能安全地读写项目数据、生成文档、同步进度和汇总报告，从而让项目流转像气泡一样顺滑。
|
||
|
||
> “Flow your work, with AI in every loop.”
|
||
|
||
---
|
||
|
||
## 二、项目愿景
|
||
|
||
构建一个能让 **人类与 AI 协作自然流动的项目平台**。
|
||
|
||
* AI 自动生成与更新任务、文档、进度
|
||
* 人类决策、审核与确认关键动作
|
||
* 系统通过 **MCP (Model Context Protocol)** 无缝连接 ChatGPT、Claude、GitHub、日历、Slack 等工具
|
||
|
||
最终，让 ColaFlow 成为开发与协作的中心枢纽。
|
||
|
||
---
|
||
|
||
## 三、项目目标
|
||
|
||
1. 兼容 Jira 式的敏捷项目管理逻辑（Epic / Story / Task / Sprint / Workflow）
|
||
2. 支持 **MCP Server + Client 双向通信**，让 AI 工具可直接操作任务数据
|
||
3. 实现 **AI 原生项目流**：文档 → 拆解 → 执行 → 汇报，全链自动化
|
||
4. 提供可审计、安全、可回滚的 AI 操作机制
|
||
5. 为内部团队与外部 AI 工具提供统一接口与权限控制层
|
||
|
||
---
|
||
|
||
## 四、系统架构
|
||
|
||
```
|
||
┌──────────────────────────────┐
|
||
│ 用户层 │
|
||
│ - Web前端 (看板/甘特/日报) │
|
||
│ - AI 工具 (ChatGPT, Claude) │
|
||
└───────────────┬──────────────┘
|
||
│ (MCP 协议)
|
||
┌───────────────┴──────────────┐
|
||
│ ColaFlow Core │
|
||
│ - 项目 / 任务 / Sprint 管理 │
|
||
│ - 文档与需求模块 │
|
||
│ - 审计与权限控制 │
|
||
└───────────────┬──────────────┘
|
||
│
|
||
┌───────────────┴──────────────┐
|
||
│ 外部系统接入层 │
|
||
│ - GitHub / Slack / Calendar │
|
||
│ - 其他 MCP 兼容工具 │
|
||
└───────────────┬──────────────┘
|
||
│
|
||
┌───────────────┴──────────────┐
|
||
│ 数据层 │
|
||
│ PostgreSQL + pgvector + Redis│
|
||
└──────────────────────────────┘
|
||
```
|
||
|
||
---
|
||
|
||
## 五、核心模块
|
||
|
||
### 1️⃣ 项目管理模块（Project Core）
|
||
|
||
* 实体结构：Epic、Story、Task、Sub-task、Sprint
|
||
* 状态流转：To Do → In Progress → Review → Done
|
||
* 看板、甘特、日历、燃尽图
|
||
* 自定义字段、标签、优先级、负责人
|
||
* 审计日志与回滚功能
|
||
|
||
---
|
||
|
||
### 2️⃣ MCP 模块（Integration Layer）
|
||
|
||
* **MCP Server：**
|
||
|
||
* 暴露 Resources：`projects.search`, `issues.search`, `docs.create_draft`, `reports.daily`
|
||
* 暴露 Tools：`create_issue`, `update_status`, `log_decision`
|
||
* 所有写操作：`diff_preview` → 人审 → commit
|
||
|
||
* **MCP Client：**
|
||
|
||
* 接入 GitHub、Slack、Calendar 等系统
|
||
* 实现事件驱动型联动：如“PR合并 → 自动更新任务状态”
|
||
|
||
* **安全与合规：**
|
||
|
||
* 字段级权限
|
||
* 审计日志与回滚
|
||
* 远程认证（OAuth/Token）
|
||
|
||
---
|
||
|
||
### 3️⃣ AI 协作模块（AI Collaboration Layer）
|
||
|
||
* 自然语言创建任务与文档
|
||
* 自动生成站会纪要、日报、风险报告
|
||
* Prompt 模板库：需求、验收标准、估时、风险提示
|
||
* “AI 控制台”：展示 AI 建议与 diff 结果，人审后落库
|
||
* 模型可替换：Claude、ChatGPT、Gemini 等
|
||
|
||
---
|
||
|
||
## 六、典型使用场景
|
||
|
||
### Use Case 1：从 Idea 到项目落地
|
||
|
||
1. 用户在 ChatGPT 提交项目构想；
|
||
2. ChatGPT 调用 MCP → ColaFlow 创建 PRD 草稿；
|
||
3. 团队在 ColaFlow 审核 diff → 确认落库；
|
||
4. 系统自动拆分任务并生成时间线；
|
||
5. 项目开始流转。
|
||
|
||
---
|
||
|
||
### Use Case 2：AI 自动维护任务
|
||
|
||
* AI 检测任务无验收标准 → 生成候选 AC；
|
||
* AI 发现进度延误 → 生成风险报告；
|
||
* AI 自动总结会议纪要 → 推送到 Slack。
|
||
|
||
---
|
||
|
||
## 七、开发阶段规划
|
||
|
||
| 阶段 | 时间 | 目标 | 交付内容 | 状态 |
|
||
| -- | ------ | -------------- | --------------------- | ---- |
|
||
| M1 | 1–2月 | 核心项目模块 | Epic/Story 结构、看板、审计日志 | 🚧 进行中 (80%) |
|
||
| M2 | 3–4月 | MCP Server 实现 | 基础读写 API、AI 连接测试 | ⏳ 未开始 |
|
||
| M3 | 5–6月 | ChatGPT 集成 PoC | 从 AI → 系统 PRD 同步闭环 | ⏳ 未开始 |
|
||
| M4 | 7–8月 | 外部系统接入 | GitHub、Calendar、Slack | ⏳ 未开始 |
|
||
| M5 | 9月 | 企业试点 | 内部部署 + 用户测试 | ⏳ 未开始 |
|
||
| M6 | 10–12月 | 稳定版发布 | 正式文档 + SDK + 插件机制 | ⏳ 未开始 |
|
||
|
||
### M1 阶段完成情况 (Day 13 更新)
|
||
|
||
#### ✅ 已完成
|
||
- **Issue Management Module (问题管理模块)** - 完整实现
|
||
- Domain Layer: Issue 聚合根、3个枚举类型、5个领域事件
|
||
- Application Layer: 5个命令 + 3个查询，完整 CQRS 架构
|
||
- Infrastructure Layer: PostgreSQL 数据库、仓储实现、5个性能索引
|
||
- API Layer: 7个 RESTful 端点
|
||
- SignalR: 实时通知支持
|
||
- 代码规模: 59个文件，1630行代码
|
||
|
||
- **Kanban Board (看板)** - 全功能实现
|
||
- 拖拽功能 (@dnd-kit 集成)
|
||
- 4列布局: Backlog → Todo → InProgress → Done
|
||
- 实时状态更新
|
||
- 类型图标 (Story, Task, Bug, Epic)
|
||
- 优先级标识
|
||
- 代码规模: 15个文件，1134行代码
|
||
|
||
- **Multi-Tenant Isolation (多租户隔离)** - 通过测试
|
||
- 全局查询过滤器正确工作
|
||
- 跨租户数据隔离验证通过
|
||
|
||
- **Database Performance (数据库性能)** - 优化完成
|
||
- 5个性能索引 (租户ID、项目ID、状态、负责人、组合索引)
|
||
- 查询性能 < 5ms
|
||
|
||
#### 🚧 进行中
|
||
- 审计日志系统 (Audit Log System)
|
||
- Epic/Story 父子关系 (Parent-Child Hierarchy)
|
||
- Sprint 管理模块 (Sprint Management)
|
||
|
||
#### ⏳ 计划中
|
||
- 自定义字段 (Custom Fields)
|
||
- 看板视图配置 (Kanban Customization)
|
||
- 甘特图 (Gantt Chart)
|
||
- 燃尽图 (Burndown Chart)
|
||
|
||
---
|
||
|
||
## 八、团队分工
|
||
|
||
| 角色 | 职责 |
|
||
| ------ | ------------------- |
|
||
| 产品经理 | 需求定义、用户调研、工作流设计 |
|
||
| 架构师 | 系统架构、MCP 集成、数据安全 |
|
||
| 后端工程师 | API、任务模型、日志系统 |
|
||
| 前端工程师 | 看板 UI、AI 控制台、人审界面 |
|
||
| AI 工程师 | Prompt 设计、任务生成、模型优化 |
|
||
| QA | 测试与回归、权限校验、性能评估 |
|
||
|
||
---
|
||
|
||
## 九、安全机制
|
||
|
||
* 所有 AI 写操作需人工确认
|
||
* 字段级访问白名单
|
||
* 审计日志 + 回滚令牌
|
||
* Token / OAuth 认证
|
||
* 可私有化部署，支持 GDPR
|
||
|
||
---
|
||
|
||
## 十、关键指标（KPI）
|
||
|
||
| 指标项 | 目标值 | 当前进展 (Day 13) |
|
||
| --------- | ----- | -------------- |
|
||
| 项目创建时间 | ↓ 30% | 🔄 开发中 (Issue 创建功能已完成) |
|
||
| AI 自动任务占比 | ≥ 50% | ⏳ 待 M2 MCP 集成后测量 |
|
||
| 人审通过率 | ≥ 90% | ⏳ 待 M2 MCP 集成后测量 |
|
||
| 回滚率 | ≤ 5% | ⏳ 待审计日志系统完成 |
|
||
| 用户满意度 | ≥ 85% | ⏳ 待 M5 企业试点测试 |
|
||
|
||
### 技术指标 (Day 13)
|
||
|
||
| 指标项 | 目标值 | 实际值 |
|
||
| --------- | ----- | ----- |
|
||
| API 响应时间 | < 100ms | ✅ 50-100ms |
|
||
| 数据库查询性能 | < 10ms | ✅ < 5ms |
|
||
| 测试覆盖率 | ≥ 80% | ⚠️ 88% (7/8 核心功能) |
|
||
| 多租户隔离 | 100% | ✅ 通过验证 |
|
||
| 代码质量 | Clean Architecture | ✅ CQRS + DDD 架构 |
|
||
|
||
---
|
||
|
||
## 十一、未来方向
|
||
|
||
* 多 AI Agent 协作（PM / Dev / QA）
|
||
* IDE 联动（VS Code / JetBrains）
|
||
* AI 提示词商店（Prompt Marketplace）
|
||
* 移动端轻量版本
|
||
* ColaFlow SDK 与插件生态
|
||
|
||
---
|
||
|
||
## 十二、结语
|
||
|
||
**ColaFlow** 的使命是：
|
||
|
||
> "让 AI 成为项目流的一部分，而不是一个外部工具。"
|
||
|
||
它不仅是一个项目管理系统，更是一个 **协作生态与智能连接平台**。
|
||
通过 ColaFlow，我们希望实现真正的「流动式团队协作」。
|
||
|
||
---
|
||
|
||
## 十三、开发进度记录
|
||
|
||
### Day 13 (2025-11-04): Issue Management & Kanban Board - ✅ 完成
|
||
|
||
#### 交付成果
|
||
1. **完整的 Issue Management 模块**
|
||
- 后端: 59个文件，1630行代码
|
||
- 前端: 15个文件，1134行代码
|
||
- 架构: Clean Architecture + CQRS + DDD
|
||
|
||
2. **Kanban Board 看板功能**
|
||
- 拖拽式任务管理
|
||
- 4个工作流阶段
|
||
- 实时状态同步
|
||
|
||
3. **测试验证**
|
||
- 8项综合测试 - 全部通过 ✅
|
||
- 多租户隔离验证 - 通过 ✅
|
||
- API性能测试 - 50-100ms 响应时间 ✅
|
||
|
||
4. **Bug修复**
|
||
- JSON枚举序列化问题 - 已修复
|
||
- API现在支持字符串枚举值
|
||
|
||
#### 技术亮点
|
||
- **领域驱动设计**: Issue 聚合根 + 5个领域事件
|
||
- **CQRS 架构**: 命令查询职责分离
|
||
- **性能优化**: 5个数据库索引，查询时间 < 5ms
|
||
- **实时通知**: SignalR 集成（基础设施就绪）
|
||
- **类型安全**: TypeScript + Zod 验证
|
||
|
||
#### Git 提交记录
|
||
- `6b11af9`: feat(backend): Implement complete Issue Management Module
|
||
- `de697d4`: feat(frontend): Add Issue management and Kanban board
|
||
- `1246445`: fix: Add JSON string enum converter for Issue Management API
|
||
- `fff99eb`: docs: Add Day 13 test results for Issue Management & Kanban
|
||
|
||
#### 下一步计划
|
||
1. **审计日志系统** (Audit Log) - M1 剩余目标
|
||
2. **Epic/Story 父子关系** - 完善任务层级结构
|
||
3. **Sprint 管理模块** - 支持敏捷迭代
|
||
4. **SignalR 实时协作测试** - 多用户场景验证
|
||
5. **性能压测** - 1000+ 任务场景测试
|
||
|
||
#### 里程碑进度
|
||
- **M1 完成度**: 80% (核心 Issue 管理 + 看板已完成)
|
||
- **M1 剩余工作**: 审计日志、Epic层级、Sprint管理
|
||
- **M1 预计完成时间**: 2周内 (2025-11-18)
|
||
|
||
--- |