10 KiB
10 KiB
Soul 创业派对 - 开发文档索引
以代码为准：需求或实现变更时同步更新本文档与对应章节 README。最后更新：2026-04-07
一、目录总览
| 目录 | 用途 |
|---|---|
| 1、需求 | 主需求、界面基准、已完成碎片、修改草稿、归档 |
| 2、架构 | 系统与技术栈、链路、超级个体方向 |
| 3、原型 | 原型设计规范 |
| 4、前端 | 小程序与管理端前端架构、细则、UI 分册 |
| 5、接口 | Soul /api 文档、支付、配置清单 |
| 6、后端 | 后端规范、架构、迁移说明、算法/ |
| 7、数据库 | 设计与管理规范 |
| 8、部署 | 部署总览、Docker、宝塔、分销、Webhook、MCP |
| 9、手册 | 手册正文与 AI 提示词 |
| 10、项目管理 | 协作说明、过程稿归档 |
| Cunkebao接口文档 | 存客宝（Cunkebao）前端项目接口 |
| 小程序管理 | 小程序审核与认证等 |
| 服务器管理 | 运维参考、虚拟机指南 |
二、根目录散落文件
| 文件 | 归属 |
|---|---|
| README.md | 开发文档总入口 |
| SKILL.md | 开发文档相关 Skill 说明 |
| api_v1.md | 存客宝对外线索上报接口（非 Soul /api）；见文内说明 |
| 三端需求业务对齐-小程序与API.md | 需求 / 对齐 |
| 小程序功能与管理端配置补齐分析.md | 需求 / 分析 |
| 列表标准与角色分工.md | 协作规范 |
| 章节拖拽排序-后台说明.md | 功能说明 |
过程记录（已迁入归档时见 10、项目管理/archive/过程稿/）
历史验收、飞书推送摘录等若已从根目录移走，请在该归档目录查找。
三、1、需求
| 文件/路径 | 用途 |
|---|---|
| 索引.md | 主需求文件规则 |
| 以界面定需求.md | 界面级需求基准 |
| 2026-03-20-需求.md | 当前主需求清单 |
| AI剪辑分发功能需求.md | 专项 |
| 链接人与事-*.md | 根下部分为 跳转 stub，正文在 archive/ |
| 已完成/ | 按日期拆分的已完成需求正文 |
| archive/ | 链接人与事等归档与线框图 |
四、2、架构
| 文件 | 用途 |
|---|---|
| README.md | 本目录索引 |
| 系统与技术.md | 系统与技术总述 |
| soul-api技术栈.md | 后端技术栈 |
| 链路与变现.md | 业务链路 |
| 超级个体（用户模块方向）.md | 用户模块方向 |
| Gin技术栈-Go1.25依赖清单.md | Go/Gin 依赖 |
五、3、原型
| 文件 | 用途 |
|---|---|
| README.md | 本目录索引 |
| 原型设计规范.md | 原型规范 |
六、4、前端
| 文件/路径 | 用途 |
|---|---|
| README.md | 本目录索引 |
| 前端架构.md | 架构 |
| 前端开发规范.md | 规范 |
| 当前小程序开发细则.md | 小程序细则 |
| 模块详解.md | 模块说明 |
| ui/ | 概述、组件、部署与截图 |
七、5、接口
| 文件 | 用途 |
|---|---|
| README.md | 本目录索引 |
| API接口完整文档.md | Soul 项目 API 主真源 |
| 配置清单-完整版.md | 配置项清单 |
| 在线支付对接文档.md | 支付 |
| 接口与提现.md | 提现相关接口说明 |
八、6、后端
| 文件/路径 | 用途 |
|---|---|
| README.md | 本目录索引 |
| 后端架构.md | soul-api 架构 |
| 后端开发规范.md | 编码与路由约定 |
| 内容创建问题修复说明.md | 专项修复说明 |
| soul-admin与Mycontent-temp内容页对比.md | 管理端内容页对比 |
| 算法/ | RFM、旅程统计、找伙伴匹配、存客宝留资 |
九、7、数据库
| 文件 | 用途 |
|---|---|
| README.md | 本目录索引 |
| 数据库设计.md | 表结构设计 |
| 数据库管理规范.md | 管理规范 |
十、8、部署
| 文件 | 用途 |
|---|---|
| README.md | 本目录文件列表 |
| 部署总览.md | 部署入口导航 |
| 运行与部署.md | 运行与部署说明 |
| DOCKER部署说明.md | Docker |
| 宝塔-Docker首次配置指南.md | 宝塔 + Docker |
| 自动化与Webhook.md | Webhook |
| 分销与绑定流程图.md、分销提现流程图.md | 分销流程 |
| 新分销逻辑-*.md、佣金*.md、邀请码分销规则说明.md | 分销与佣金专题 |
| 支付接口清单.md、章节阅读付费标准流程设计.md、阅读页标准流程改造说明.md | 支付与阅读 |
| 存客宝API-Key约定.md | 存客宝密钥 |
| API接入说明.md | API 接入 |
| MCP-MySQL配置说明.md、Soul-MySQL-MCP配置说明.md | MCP |
| VIP功能-数据库迁移说明.md、代码逻辑和数据库最终检查清单.md | 迁移与检查 |
| 宝塔面板配置订单同步定时任务.md、其它.md | 运维杂项 |
历史上计划单独编写的《宝塔反向代理说明》《提现功能完整技术文档》《订阅消息》《商家转账》若未落盘，请在 部署总览.md 中按「等价内容」指向现有文档或
5、接口、soul-api代码注释。
十一、9、手册
| 文件/路径 | 用途 |
|---|---|
| 手册索引.md | 手册与提示词总索引 |
| 写作与结构维护手册.md | 书籍写作规范 |
| 全站捆绑分销体系-SCALE.md | 分销规格 |
| 使用手册提示词.md | 卡若风格操作手册 AI 角色（主入口） |
| 提示词/ | 落地方案、说明手册、截图/Word 工具需求等 |
十二、10、项目管理
| 文件/路径 | 用途 |
|---|---|
| README.md | 本目录说明 |
| 闭环与文档同步-2026-04-07.md | 需求与开发文档对齐后的闭环结论与待办 |
| 存客宝协作需求.md | 协作需求 |
| 项目管理提示词.md | 项目管理向 AI 提示词 |
| archive/过程稿/ | 飞书推送摘录、全站修复报告、提审清单等过程稿 |
十三、Cunkebao 与小程序/服务器管理
| 路径 | 用途 |
|---|---|
| Cunkebao接口文档/README.md | 存客宝前端接口目录说明 |
| Cunkebao接口文档/API接口清单.md | 接口清单 |
| Cunkebao接口文档/入参出参结构.md | 类型与结构 |
| 小程序管理/SKILL.md | 小程序管理 Skill |
| 服务器管理/SKILL.md | 服务器管理 Skill |
十四、仓库内其他文档入口
| 路径 | 用途 |
|---|---|
scripts/test/功能测试流程.md |
若仓库内已提供则补充链接（当前仓库可无此路径） |
| soul-api/文档索引.md | 后端指向本开发文档 |
| miniprogram/README.md | 小程序项目说明 |
十五、场景速查
| 场景 | 推荐文档 |
|---|---|
| 新增/变更功能 | 以界面定需求.md → 2026-03-20-需求.md |
| Soul API | 5、接口/API接口完整文档.md |
| RFM / 找伙伴规则 | 6、后端/算法/ |
| 部署 | 8、部署/部署总览.md |
| 存客宝前端 | Cunkebao接口文档/ |
| 对外线索上报（非 Soul） | api_v1.md |