Skip to content

Commit 85b1eeb

Browse files
docs: Update root README with complete feature list and current project status
- Update project description to reflect AI-powered collaborative platform - Expand core capabilities (7 items → AI writing, document linking, analytics, etc.) - Update tech stack table (add AI, Charts, Image processing; fix versions) - Rewrite all Stage progress sections to reflect actual completion status - Stage 0-8 all marked as completed with detailed feature lists - Stage 9 (pre-launch) listed as pending - Remove outdated "待集成" labels from Yjs and Tiptap Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 9eb7394 commit 85b1eeb

1 file changed

Lines changed: 72 additions & 41 deletions

File tree

README.md

Lines changed: 72 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<img src="docStudio_icon.png" width="200" height="200" alt="DocStudio Icon" />
55
</div>
66

7-
DocStudio 是一个**团队协作文档平台**,旨在成为团队的**知识库系统**。它提供类似 Notion 的体验,支持多文档管理、实时协作和知识沉淀
7+
DocStudio 是一个**AI 驱动的实时协作知识管理平台**。支持多人实时编辑、AI 辅助写作、文档互链、数据洞察,打造团队知识库的最佳实践
88

99
[![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue)](https://www.typescriptlang.org/)
1010
[![Next.js](https://img.shields.io/badge/Next.js-15-black)](https://nextjs.org/)
@@ -13,11 +13,15 @@ DocStudio 是一个**团队协作文档平台**,旨在成为团队的**知识
1313

1414
---
1515

16-
### 核心价值
16+
### 核心能力
1717

18-
- **知识沉淀**:将团队知识集中管理,避免信息孤岛
19-
- **高效协作**:支持多人实时编辑,提升团队协作效率
20-
- **灵活扩展**:基于 Monorepo 架构,易于扩展新功能
18+
- **实时协作** — 多人同时编辑,光标实时同步,冲突自动解决(Yjs + Hocuspocus)
19+
- **AI 辅助写作** — 续写/润色/翻译/摘要、Copilot 行内补全、AI 文档对话、深度思考模式
20+
- **知识网络**`[[` 文档互链、全文搜索、文档树层级管理
21+
- **数据洞察** — 空间数据面板、文档阅读统计、个人生产力指标
22+
- **灵活权限** — 空间/文档级权限、公开/私有切换、带密码的分享链接
23+
- **导入导出** — Markdown/HTML/DOCX 导入,Markdown/HTML/PDF 导出
24+
- **AI 订阅制** — 三档套餐(普通/VIP/Max),申请审批,按月/按年计费
2125

2226
---
2327

@@ -93,14 +97,17 @@ docStudio/
9397

9498
| 领域 | 技术选型 |
9599
| ---------- | ------------------------------------ |
96-
| **包管理** | pnpm workspace |
97-
| **前端** | Next.js 15, React 19, Tailwind CSS 4 |
100+
| **包管理** | pnpm workspace (Monorepo) |
101+
| **前端** | Next.js 16, React 19, Tailwind CSS 4 |
98102
| **后端** | NestJS 11, Fastify |
99103
| **数据库** | PostgreSQL 16, Prisma 5.22 |
100104
| **缓存** | Redis 7 |
101105
| **存储** | MinIO (S3 兼容) |
102-
| **协作** | Yjs + Hocuspocus(待集成) |
103-
| **编辑器** | Tiptap(待集成) |
106+
| **协作** | Yjs + Hocuspocus (WebSocket CRDT) |
107+
| **编辑器** | Tiptap 3 (ProseMirror) |
108+
| **AI** | OpenAI 兼容 API (SSE 流式) |
109+
| **图表** | Recharts + D3 |
110+
| **图像** | Sharp (压缩/缩略图/WebP) |
104111
| **语言** | TypeScript 5.9 |
105112

106113
---
@@ -150,56 +157,80 @@ pnpm exec prisma studio # 可视化工具
150157

151158
---
152159

153-
### ✅ Stage 0: 基础设施(已完成)
160+
### ✅ Stage 0: 基础设施
154161

155-
- [x] Monorepo 项目结构
156-
- [x] 前端基础框架(Next.js 15)
157-
- [x] 后端基础框架(NestJS + Fastify
158-
- [x] 数据库 Schema 设计(Prisma
162+
- [x] Monorepo 项目结构 (pnpm workspace)
163+
- [x] 前端框架 (Next.js 16 + React 19)
164+
- [x] 后端框架 (NestJS 11 + Fastify)
165+
- [x] 数据库 Schema (PostgreSQL + Prisma)
159166
- [x] Docker 开发环境 (PostgreSQL, Redis, MinIO)
160-
- [x] 用户认证(JWT + GitHub OAuth)
167+
- [x] 用户认证 (JWT)
161168

162-
### ✅ Stage 1: 核心功能(已完成)
169+
### ✅ Stage 1: 核心功能
163170

164171
- [x] Space 工作空间管理
165172
- [x] Document 文档 CRUD
166-
- [x] Tiptap 编辑器基础集成
173+
- [x] Tiptap 富文本编辑器(表格、代码块、Callout、数学公式、绘图)
167174
- [x] 文档树结构与拖拽排序
168175

169-
### ✅ Stage 2: 公开访问层(已完成)
176+
### ✅ Stage 2: 公开访问层
170177

171-
- [x] 项目首页(Hero Section)
172-
- [x] 公开工作空间展示列表
173-
- [x] 公开文档阅读页(SEO 优化)
178+
- [x] 项目首页(动画 Hero + 特性展示 + 用户评价)
179+
- [x] 探索页(公开空间列表 + 排序/分页)
180+
- [x] 公开文档阅读页
181+
- [x] SEO 优化(sitemap / robots.txt / JSON-LD / OG Tags)
174182

175-
### ✅ Stage 3: 团队协作功能(已完成)
183+
### ✅ Stage 3: 团队协作
176184

177-
- [x] 团队权限管理(Owner/Editor/Viewer)
178-
- [x] 私密分享链接(ShareToken)
185+
- [x] 权限管理(Owner/Editor/Viewer)+ 文档级权限
186+
- [x] 成员邀请和管理
187+
- [x] 私密分享链接(密码 + 有效期)+ 分享管理
188+
- [x] Rate Limiting 安全加固
179189

180-
### Stage 4: 高级功能(待开发)
190+
### Stage 4: 高级功能
181191

182-
- [x] 文件上传与头像设置 (MinIO)
183-
- [ ] 实时协作(Yjs + Hocuspocus)
184-
- [ ] 文档版本历史
192+
- [x] 实时多人协作(Yjs + Hocuspocus + 光标同步)
193+
- [x] 文件上传(Sharp 压缩 + 缩略图 + WebP + 附件)
194+
- [x] 版本历史和恢复
195+
- [x] 全文搜索
196+
- [x] 活动日志 / 最近访问
197+
- [x] 文档模板系统
198+
- [x] 评论系统(行内标注 + 回复 + 解决)
185199

186-
### ✅ Stage 5: 超级管理员系统(已完成)
200+
### ✅ Stage 5: 超级管理员
187201

188-
- [x] 平台级超级管理员角色(`isSuperAdmin`
189-
- [x] 用户禁用/启用(`isDisabled`
190-
- [x] 管理控制台 - 用户列表(分页、搜索、按空间筛选)
191-
- [x] 管理控制台 - 修改密码、禁用、删除用户
192-
- [x] 启动时自动初始化超管账号
202+
- [x] 平台级超管角色 + 自动 Bootstrap
203+
- [x] 用户管理控制台(搜索/筛选/禁用/删除/改密)
193204

194-
### 💡 Stage 6: 数据与洞察(规划中 / Post-MVP)
205+
### Stage 6-7: 产品打磨与增长
195206

196-
- [ ] 文档访问统计(PV / UV)
197-
- [ ] 访问明细记录(时间、地区、访客信息)
198-
- [ ] 工作空间级数据看板
199-
- [ ] 个人内容仪表盘
200-
- [ ] 文档评论与互动(游客评论、嵌套回复、点赞)
207+
- [x] 回收站(软删除 + 30 天自动清理)
208+
- [x] 通知系统(SSE 实时推送 + 8 种类型 + 偏好设置)
209+
- [x] 收藏与快捷访问
210+
- [x] 导入导出(Markdown/HTML/DOCX 导入 + Markdown/HTML/PDF 导出)
211+
- [x] 文档互链(`[[` 语法搜索 + 分享页权限检查)
212+
- [x] 数据洞察(空间面板 + 文档统计 + Dashboard 增强)
213+
- [x] 快捷键弹窗
201214

202-
> 详细规划请查看:[DocStudio v1 产品文档](./DocStudio%20v1–文档.md)
215+
### ✅ Stage 8: AI 辅助写作
216+
217+
- [x] AI 写作命令(续写/润色/翻译/摘要/扩写/缩写/自定义)
218+
- [x] AI 内联面板(选中文字下方弹出 + 预设命令 + 流式结果)
219+
- [x] Copilot 行内补全(ghost text + Tab 接受)
220+
- [x] AI 文档对话侧栏(多轮对话 + 浮窗/侧栏双模式)
221+
- [x] 深度思考模式 + Markdown 渲染 + 代码高亮
222+
- [x] AI 后台配置(Provider/Key/Model/限额)
223+
- [x] AI 订阅制(三档套餐 + 申请审批 + 按月/按年)
224+
- [x] LLM Provider 抽象层(OpenAI 兼容,支持 MiniMax/DeepSeek)
225+
226+
### 📋 Stage 9: 上线前必备(待开发)
227+
228+
- [ ] 密码重置 / 邮箱验证 / 邮件服务
229+
- [ ] OAuth 登录(Google/GitHub)
230+
- [ ] 404/500 错误页面 + 全局错误边界
231+
- [ ] 安全 Headers + JWT 刷新
232+
- [ ] 移动端适配
233+
- [ ] 新用户引导流程
203234

204235
---
205236

0 commit comments

Comments
 (0)