169 lines
8.8 KiB
Markdown
169 lines
8.8 KiB
Markdown
# 知习 ZhiXi 文档中心
|
||
|
||
> 所有技术设计和项目规划文档的总索引。
|
||
|
||
---
|
||
|
||
## 目录结构
|
||
|
||
```
|
||
├── 技术设计/ 系统怎么建（按项目分文件夹）
|
||
├── 开发计划/ 先做什么后做什么（按项目分文件夹）
|
||
├── 长期规划/ 为什么做、给谁做
|
||
├── 凭据配置/ 服务器密码和密钥（已 gitignore）
|
||
└── 图片资源/ 产品图片
|
||
```
|
||
|
||
### 状态标识说明
|
||
|
||
| 前缀 | 含义 | 适用场景 |
|
||
|------|------|----------|
|
||
| `[已完成]` | 设计已落实到代码，功能可运行 | 技术设计文档 |
|
||
| `[进行中]` | 部分实现/持续更新中 | 技术设计 + 开发计划 |
|
||
| `[设计中]` | 纯设计文档，尚未开始实现 | 技术设计文档 |
|
||
| `[参考]` | 静态参考文档，内容不再变动 | 需求基线等 |
|
||
| `[快照]` | 一次性审计快照，记录某个时间点的状态 | 差距分析等 |
|
||
|
||
---
|
||
|
||
## 技术设计
|
||
|
||
### api-server（后端）
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [进行中-架构总览](技术设计/api-server/[进行中]-架构总览.md) | 模块化单体架构、技术栈、目录结构、14个业务模块、API路由规划、数据模型（模块骨架存在，队列/AI异步未完成） |
|
||
| [进行中-Redis缓存设计](技术设计/api-server/[进行中]-Redis缓存设计.md) | 缓存/队列/限流设计，Redis 已连接，BullMQ 队列待替换内存队列 |
|
||
| [设计中-AI架构设计](技术设计/api-server/[设计中]-AI架构设计.md) | AI Provider 抽象、四层模型策略、Agent 演进路线 V0-V3 |
|
||
|
||
#### 已完成
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [数据库设计](技术设计/api-server/已完成/[已完成]-数据库设计.md) | 27 张表完整设计，Prisma schema 已落地，MySQL 运行中 |
|
||
| [安全规范](技术设计/api-server/已完成/[已完成]-安全规范.md) | 安全基线：Helmet、CORS、JWT Guard、参数校验、限流、Swagger保护 |
|
||
| [登录流程-总览](技术设计/api-server/已完成/[已完成]-登录流程/总览.md) | 登录系统整体设计：前后端职责、Token 策略、5 个 API 接口规划 |
|
||
| [登录流程-Apple登录集成](技术设计/api-server/已完成/[已完成]-登录流程/Apple登录集成.md) | Sign in with Apple 后端实现：jose 验签、JWKS、字段信任模型 |
|
||
| [登录流程-后端接口](技术设计/api-server/已完成/[已完成]-登录流程/后端接口.md) | dev-login / refresh / logout / /users/me 四个接口的详细实现 |
|
||
| [登录流程-数据库设计](技术设计/api-server/已完成/[已完成]-登录流程/数据库设计.md) | users / auth_accounts / refresh_tokens 三表 Prisma Schema |
|
||
|
||
### ios-projects（iOS 客户端）
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [进行中-架构设计](技术设计/ios-projects/[进行中]-架构设计.md) | 当前项目文件结构、导航架构、与计划架构的差异表（28项未实现），UI 层完成但无 MVVM |
|
||
| [设计中-登录集成](技术设计/ios-projects/[设计中]-登录集成.md) | iOS 端登录设计：AuthService、Keychain 存储、Token 自动刷新、401 重试，均未实现 |
|
||
| [样式规范](技术设计/ios-projects/已完成/[已完成]-样式规范.md) | 完整设计系统：颜色、渐变、圆角、间距、字体、29 个共享组件、页面模板 |
|
||
| [页面规划](技术设计/ios-projects/已完成/[已完成]-页面规划.md) | 22 个页面完整清单，UI 层全部实现（Onboarding 5页 + 主Tab 5页 + 子页12页） |
|
||
|
||
### web-projects（官网）
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [设计中-设计文档](技术设计/web-projects/[设计中]-设计文档.md) | 官网视觉设计系统："Luminous Clarity" 玻璃拟态浅色主题 |
|
||
|
||
### miniapp-projects（微信小程序）
|
||
|
||
> 暂无文档，预留目录。
|
||
|
||
### harmonyos-projects（鸿蒙）
|
||
|
||
> 暂无文档，预留目录。
|
||
|
||
### admin-projects（后台管理）
|
||
|
||
> 暂无文档，预留目录。
|
||
|
||
### android-projects / webApp-projects
|
||
|
||
> 暂无文档，预留目录。
|
||
|
||
---
|
||
|
||
## 开发计划
|
||
|
||
### 跨项目
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [进行中-阶段路线图](开发计划/[进行中]-阶段路线图.md) | 产品 9 阶段整体路线。阶段0官网部分已完成，阶段1方向选择进行中 |
|
||
| [进行中-潜在问题清单](开发计划/[进行中]-潜在问题清单.md) | 代码和策略中已发现问题，按🔴严重/🟠高危/🟡中危分级，持续更新（最新：2026-05-15） |
|
||
|
||
### api-server
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [进行中-后端开发优先级](开发计划/api-server/[进行中]-后端开发优先级.md) | 51 模块 14 层级总表 + 8 阶段开发路线 + 每个模块接口/表结构/流程详案 |
|
||
|
||
### ios-projects
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [参考-功能需求清单](开发计划/ios-projects/[参考]-功能需求清单.md) | 从 v0.1 创业计划提取的 iOS 功能需求基线 |
|
||
| [进行中-缺失项与待补全方向](开发计划/ios-projects/[进行中]-缺失项与待补全方向.md) | iOS 架构/页面/功能/设计缺失项梳理，含 P0/P1/P2 优先级 |
|
||
| [差距分析](开发计划/ios-projects/已完成/[已完成]-差距分析.md) | 两轮审计快照合并：现有资源盘点 + P0 任务分解 |
|
||
|
||
### web-projects / android-projects / webApp-projects
|
||
|
||
> 暂无开发计划文档，预留目录。
|
||
|
||
---
|
||
|
||
## 长期规划
|
||
|
||
### 产品方向
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [进行中-个人开发者创业计划](长期规划/[进行中]-个人开发者创业计划.md) | 整体创业策略：Apple-first、验证优先级、长期架构 |
|
||
| [参考-产品与用户模块](长期规划/[参考]-产品与用户模块.md) | 产品定位、目标用户、核心价值主张 |
|
||
| [参考-产品方向深度评估](长期规划/[参考]-产品方向深度评估.md) | 知识库方向选择评估维度和候选方案 |
|
||
| [参考-技术与交付模块](长期规划/[参考]-技术与交付模块.md) | 技术选型决策、开发流程、交付标准 |
|
||
|
||
### 商业化
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [进行中-商业化与支付模块](长期规划/[进行中]-商业化与支付模块.md) | 订阅定价、Apple IAP、会员权益体系 |
|
||
|
||
### 营销与增长
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [进行中-营销与增长模块](长期规划/营销与增长/[进行中]-营销与增长模块.md) | 营销策略总纲 |
|
||
| [参考-营销冷启动调研方案](长期规划/营销与增长/[参考]-营销冷启动调研方案.md) | 冷启动阶段获客调研方案 |
|
||
| [参考-冷启动与增长深度调研](长期规划/营销与增长/[参考]-冷启动与增长深度调研.md) | 增长策略深度调研 |
|
||
|
||
### 运营与客服
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [进行中-运营与客服模块](长期规划/运营与客服/[进行中]-运营与客服模块.md) | 运营策略总纲 |
|
||
| [参考-客服设计详案](长期规划/运营与客服/[参考]-客服设计详案.md) | 客服流程和工单系统设计 |
|
||
|
||
### 合规与数据
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [设计中-数据反馈与迭代模块](长期规划/[设计中]-数据反馈与迭代模块.md) | 数据埋点、用户反馈收集、迭代流程 |
|
||
| [设计中-合规与公司化模块](长期规划/[设计中]-合规与公司化模块.md) | 公司注册、ICP备案、隐私合规、Apple审核要求 |
|
||
|
||
---
|
||
|
||
## 快速定位
|
||
|
||
| 我想知道... | 看这个 |
|
||
|-------------|--------|
|
||
| 后端整体怎么设计？ | [技术设计/api-server/架构总览](技术设计/api-server/[进行中]-架构总览.md) |
|
||
| 数据库有哪些表？ | [技术设计/api-server/数据库设计](技术设计/api-server/已完成/[已完成]-数据库设计.md) |
|
||
| 登录怎么做？ | [技术设计/api-server/登录流程/总览](技术设计/api-server/已完成/[已完成]-登录流程/总览.md) |
|
||
| iOS App 架构？ | [技术设计/ios-projects/架构设计](技术设计/ios-projects/[进行中]-架构设计.md) |
|
||
| 接下来做什么？ | [开发计划/阶段路线图](开发计划/[进行中]-阶段路线图.md) |
|
||
| 后端先开发哪些？ | [开发计划/api-server/后端开发优先级](开发计划/api-server/[进行中]-后端开发优先级.md) |
|
||
| iOS 还差什么？ | [开发计划/ios-projects/缺失项与待补全方向](开发计划/ios-projects/[进行中]-缺失项与待补全方向.md) |
|
||
| 有哪些已知问题？ | [开发计划/潜在问题清单](开发计划/[进行中]-潜在问题清单.md) |
|
||
| 产品方向怎么定的？ | [长期规划/产品方向深度评估](长期规划/[参考]-产品方向深度评估.md) |
|
||
| 怎么收费？ | [长期规划/商业化与支付模块](长期规划/[进行中]-商业化与支付模块.md) |
|
||
| 怎么获客？ | [长期规划/营销与增长/营销冷启动调研方案](长期规划/营销与增长/[参考]-营销冷启动调研方案.md) |
|
||
| 服务器密码、SSH密钥？ | [凭据配置/服务器凭据](凭据配置/服务器凭据.md) |
|