153 lines
8.3 KiB
Markdown
153 lines
8.3 KiB
Markdown
# 知习 ZhiXi 文档中心
|
||
|
||
> 所有技术设计和项目规划文档的总索引。
|
||
|
||
---
|
||
|
||
## 目录结构
|
||
|
||
```
|
||
├── 技术设计/ 系统设计 + 开发计划（已合并）
|
||
├── 长期规划/ 为什么做、给谁做
|
||
└── 图片资源/ 产品图片
|
||
```
|
||
|
||
---
|
||
|
||
## 技术设计
|
||
|
||
### api-server（后端）
|
||
|
||
**设计与规划：**
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [架构总览](技术设计/api-server/架构总览.md) | 模块化单体架构、技术栈、目录结构、14个业务模块、API路由规划、数据模型 |
|
||
| [后端开发路线图](技术设计/api-server/后端开发路线图.md) | 51 模块 14 层级总表 + 8 阶段开发路线 + 每个模块接口/表结构/流程详案 |
|
||
| [后端待完成事项清单](技术设计/api-server/后端待完成事项清单.md) | 当前待推进的详细任务 |
|
||
| [AI架构设计](技术设计/api-server/AI架构设计.md) | AI Provider 抽象、四层模型策略、Agent 演进路线 V0-V3 |
|
||
| [Redis缓存设计](技术设计/api-server/Redis缓存设计.md) | 缓存/队列/限流设计 |
|
||
|
||
**已完成：**
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [已实现功能汇总](技术设计/api-server/已完成/[已完成]-已实现功能汇总.md) | 全部已完成功能一览：基础设施、14 模块、AI 三层架构、安全基线 |
|
||
| [后端实现状态](技术设计/api-server/已完成/[已完成]-后端实现状态.md) | 各模块完成度 + 基础设施状态 + 待推进方向 |
|
||
| [数据库设计](技术设计/api-server/已完成/[已完成]-数据库设计.md) | 27 张表完整设计，Prisma schema 已落地 |
|
||
| [安全规范](技术设计/api-server/已完成/[已完成]-安全规范.md) | 安全基线：Helmet、CORS、JWT Guard、RolesGuard、参数校验、限流 |
|
||
| [当前状态与决策清单](技术设计/api-server/已完成/[已完成]-当前状态与决策清单.md) | 技术决策与当前状态记录 |
|
||
| [AI架构决策清单](技术设计/api-server/已完成/[已完成]-AI架构决策清单.md) | AI 层具体决策记录 |
|
||
| [登录流程/总览](技术设计/api-server/已完成/[已完成]-登录流程/总览.md) | 登录系统整体设计 |
|
||
| [登录流程/Apple登录集成](技术设计/api-server/已完成/[已完成]-登录流程/Apple登录集成.md) | Sign in with Apple 后端实现 |
|
||
| [登录流程/后端接口](技术设计/api-server/已完成/[已完成]-登录流程/后端接口.md) | 登录相关接口实现 |
|
||
| [登录流程/数据库设计](技术设计/api-server/已完成/[已完成]-登录流程/数据库设计.md) | 登录相关表设计 |
|
||
|
||
### ios-projects（iOS 客户端）
|
||
|
||
**设计与规划：**
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [架构设计](技术设计/ios-projects/架构设计.md) | 项目文件结构、导航架构、差异表 |
|
||
| [登录集成](技术设计/ios-projects/登录集成.md) | AuthService、Keychain 存储、Token 刷新 |
|
||
| [功能需求清单](技术设计/ios-projects/功能需求清单.md) | iOS 功能需求基线 |
|
||
| [缺失项与待补全方向](技术设计/ios-projects/缺失项与待补全方向.md) | 架构/页面/功能缺失项梳理 |
|
||
|
||
**已完成：**
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [已实现功能汇总](技术设计/ios-projects/已完成/[已完成]-已实现功能汇总.md) | 全部已完成功能一览：架构层、22 页面、Auth、设计系统、代码质量 |
|
||
| [样式规范](技术设计/ios-projects/已完成/[已完成]-样式规范.md) | 完整设计系统：颜色、渐变、圆角、间距、字体、29 个共享组件 |
|
||
| [页面规划](技术设计/ios-projects/已完成/[已完成]-页面规划.md) | 22 个页面完整清单 |
|
||
| [差距分析](技术设计/ios-projects/已完成/[已完成]-差距分析.md) | 现有资源盘点 + P0 任务分解 |
|
||
|
||
### 跨项目
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [总待完成清单](技术设计/总待完成清单.md) | **← 主文件**：后端/iOS/策略所有待完成事项，按优先级排列，链接到各详细文档 |
|
||
| [阶段路线图](技术设计/阶段路线图.md) | 产品 9 阶段整体路线 |
|
||
| [潜在问题清单](技术设计/潜在问题清单.md) | 按🔴严重/🟠高危/🟡中危分级，持续更新 |
|
||
|
||
### web-projects（官网）
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [设计文档](技术设计/web-projects/设计文档.md) | 官网视觉设计系统："Luminous Clarity" 玻璃拟态浅色主题 |
|
||
|
||
### admin-projects（管理后台）
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [项目 README](../admin-projects/README.md) | 技术栈、目录结构、认证流程、角色体系 |
|
||
|
||
### 预留目录
|
||
|
||
`miniapp-projects` `harmonyos-projects` `android-projects` `webApp-projects` — 暂无文档。
|
||
|
||
---
|
||
|
||
## 长期规划
|
||
|
||
### 产品方向
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [进行中-个人开发者创业计划](长期规划/[进行中]-个人开发者创业计划.md) | 整体创业策略：Apple-first、验证优先级、长期架构 |
|
||
| [参考-产品与用户模块](长期规划/[参考]-产品与用户模块.md) | 产品定位、目标用户、核心价值主张 |
|
||
| [参考-产品方向深度评估](长期规划/[参考]-产品方向深度评估.md) | 知识库方向选择评估维度和候选方案 |
|
||
| [参考-技术与交付模块](长期规划/[参考]-技术与交付模块.md) | 技术选型决策、开发流程、交付标准 |
|
||
|
||
### 商业化
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [进行中-商业化与支付模块](长期规划/[进行中]-商业化与支付模块.md) | 订阅定价、Apple IAP、会员权益体系 |
|
||
|
||
### 营销与增长
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [进行中-营销与增长模块](长期规划/营销与增长/[进行中]-营销与增长模块.md) | 营销策略总纲 |
|
||
| [参考-营销冷启动调研方案](长期规划/营销与增长/[参考]-营销冷启动调研方案.md) | 冷启动阶段获客调研方案 |
|
||
| [参考-冷启动与增长深度调研](长期规划/营销与增长/[参考]-冷启动与增长深度调研.md) | 增长策略深度调研 |
|
||
|
||
### 运营与客服
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [进行中-运营与客服模块](长期规划/运营与客服/[进行中]-运营与客服模块.md) | 运营策略总纲 |
|
||
| [参考-客服设计详案](长期规划/运营与客服/[参考]-客服设计详案.md) | 客服流程和工单系统设计 |
|
||
|
||
### 合规与数据
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [设计中-数据反馈与迭代模块](长期规划/[设计中]-数据反馈与迭代模块.md) | 数据埋点、用户反馈收集、迭代流程 |
|
||
| [设计中-合规与公司化模块](长期规划/[设计中]-合规与公司化模块.md) | 公司注册、ICP备案、隐私合规、Apple审核要求 |
|
||
|
||
---
|
||
|
||
## 快速定位
|
||
|
||
| 我想知道... | 看这个 |
|
||
|-------------|--------|
|
||
| **现在该做什么？** | [**总待完成清单**](技术设计/总待完成清单.md) |
|
||
| 后端整体怎么设计？ | [架构总览](技术设计/api-server/架构总览.md) |
|
||
| 后端完成了哪些功能？ | [已实现功能汇总](技术设计/api-server/已完成/[已完成]-已实现功能汇总.md) |
|
||
| 后端实现到什么程度了？ | [后端实现状态](技术设计/api-server/已完成/[已完成]-后端实现状态.md) |
|
||
| 后端先开发哪些？ | [后端开发路线图](技术设计/api-server/后端开发路线图.md) |
|
||
| 数据库有哪些表？ | [数据库设计](技术设计/api-server/已完成/[已完成]-数据库设计.md) |
|
||
| 登录怎么做？ | [登录流程/总览](技术设计/api-server/已完成/[已完成]-登录流程/总览.md) |
|
||
| iOS 完成了哪些功能？ | [已实现功能汇总](技术设计/ios-projects/已完成/[已完成]-已实现功能汇总.md) |
|
||
| iOS App 架构？ | [iOS架构设计](技术设计/ios-projects/架构设计.md) |
|
||
| iOS 还差什么？ | [缺失项与待补全方向](技术设计/ios-projects/缺失项与待补全方向.md) |
|
||
| 接下来做什么？ | [阶段路线图](技术设计/阶段路线图.md) |
|
||
| 有哪些已知问题？ | [潜在问题清单](技术设计/潜在问题清单.md) |
|
||
| 产品方向怎么定的？ | [产品方向深度评估](长期规划/[参考]-产品方向深度评估.md) |
|
||
| 怎么收费？ | [商业化与支付模块](长期规划/[进行中]-商业化与支付模块.md) |
|
||
| 怎么获客？ | [营销冷启动调研方案](长期规划/营销与增长/[参考]-营销冷启动调研方案.md) |
|
||
| 服务器密码、SSH密钥？ | [服务器凭据](凭据配置/服务器凭据.md) |
|