生成日期:2026-10-06(v1.0 基础篇 → v1.1 扩展篇 → v1.2 加厚篇 → 一致性回刷)| 覆盖:
/Users/zhangzhengyang/Desktop/publish下 19 个项目 | 共 396 篇 Markdown 文档、392 张 Mermaid 图表所有文档均基于源码精读撰写(非臆测),无法从源码确认的信息已在文中标注
⚠️ 待确认。生成过程未修改任何项目源码。
18 个项目,每个一套 21 篇标准文档,分三个层次:
| 篇目 | 内容 |
|---|---|
00-项目总览 | 定位、功能清单、技术栈选型、目录导览、快速上手 |
01-系统架构 | 架构图、分层与模块职责、数据流、设计决策与模式 |
02-页面设计 | 路由与页面总表、核心页面布局交互、组件树、状态管理(组件库项目为「组件设计」,库项目为「模块设计」) |
03-接口设计 | API 契约、鉴权机制、错误处理约定(纯前端项目改为外部 API 集成设计) |
04-数据模型 | 存储方案、表/实体结构、ER 图、数据生命周期 |
05-核心流程 | 3-5 条端到端业务流程,配时序图/流程图分步拆解 |
06-部署运行 | 环境要求、命令级启动、环境变量清单、部署链路、测试与质量门禁 |
| 篇目 | 内容 |
|---|---|
07-模块详解 | 逐模块/逐文件函数级深读:职责、导出清单表、机制走读、模块间交互 |
08-安全与权限设计 | 认证会话、鉴权模型、输入校验、注入面、密钥管理、已知隐患清单 |
09-测试与质量保障 | 测试体系全景、代表性用例解析、覆盖率与门禁、缺口与补测建议 |
10-性能设计与优化 | 性能关键路径、已实施优化手段(指认实现文件)、事故复盘、按 ROI 排序的建议 |
11-扩展开发指南 | 3-6 个典型扩展场景 SOP:目录约定、登记点、验收清单、易错点 |
12-FAQ与故障排查 | 高频报错与坑(现象/根因/解决/出处)、mermaid 排查决策树、日志与调试入口 |
13-技术债务与演进建议 | 问题台账(位置/证据/影响/建议)、死代码与口径不一、分阶段演进路线图 |
14-配置与环境详解 | 配置文件逐段走读、环境变量全清单(读取点/缺失后果)、脚本全量说明 |
15-接口全量参考 | 全量端点/导出/字段速查大表(比 03 篇更细更全),配 mermaid 总览图 |
| 篇目 | 内容 |
|---|---|
16-决策记录ADR | 8-12 条关键架构决策考古:背景/备选/决策/源码证据/后果(含"计划≠落地"偏差) |
17-依赖全景 | 全部第三方依赖逐个:用途、grep 使用位置证据、选型理由、替代方案、升级风险、健康度评估 |
18-代码走读实录 | 2-3 个核心文件逐段带码精读,每段附「这段代码教会我们什么」 |
19-数据契约与示例集 | 核心 API/数据结构的可 curl 重放示例集(JSON 构造、示意值标注、错误形态齐全) |
20-术语表与文档索引 | 术语表(带源码锚点)+ 源码文件↔篇目反向索引 + 按任务阅读路径,全 21 篇闭环 |
例外:devtools/ 为 2026-09-27 生成的 18 册深度文档集(架构篇/页面篇/工程篇/附录),按所有者决定保留原状,未参与扩展。
| 项目 | 定位 | 技术栈 | 篇数 |
|---|---|---|---|
| mall | xyMall 前后端分离电商(后端 + 商城 Web + H5 + 管理后台四端) | Spring Boot 3 多模块 · Vue 3 · Element Plus · MySQL/Redis | 21 |
| x-pan | 私人分布式云存储(模块化单体后端 + Web + Flutter 三端,分片上传/秒传/分享/保险箱) | Spring Boot 3 · Vue 3 · Flutter · MySQL/Redis/MinIO | 21 |
| erp | ERP/CRM 业务系统(多租户,Flowable 审批流,含代码生成机制) | 后端服务 + erpcrm-ui 前端 | 21 |
| interview-platform | AI 面试准备平台(题库、AI 模拟面试、竞赛、看板) | Next.js 16 · Prisma · PostgreSQL · NextAuth · DeepSeek/火山引擎 | 21 |
| react-travel | 小叶旅游网(CRA SPA 迁移 Next.js 的双层架构全栈站点) | Next.js 15 · React 18 · antd 5 · Zustand · Prisma | 21 |
| webCommand | 网页版命令行终端(前后端合并工程,云同步) | Nuxt 4 SPA · Nitro API · ant-design-vue · Pinia · MySQL | 21 |
| vue3-course | 运营搭建平台(低代码页面/数据看板搭建、三阶段发布) | Vue 3 · Koa · pnpm monorepo | 21 |
| XSearch | 分布式爬虫与全文检索站(采集→存储→搜索全链路) | Scrapy · Elasticsearch · Django · Vue 3 | 21 |
| nestjs-admin | 后台管理系统(微服务后端 + Vue 管理端) | NestJS 微服务 · Consul 网关 · Vue 3 | 21 |
| 项目 | 定位 | 技术栈 | 篇数 |
|---|---|---|---|
| PEXELS | 壁纸应用(Pexels API 直连,无 Key 降级 Picsum;自研瀑布流虚拟滚动) | Vue 3 · Vite · Pinia · Tailwind 4 | 21 |
| html5-examples | HTML5 示例合集大站(示例 + CSS 实验室,iframe 沙箱内核) | Vue 3 · NestJS · Monaco · ECharts | 21 |
| html5-dataviz | 数据可视化案例站(echarts/antv/three/webgl 四库 2000+ 案例 + 22 数据大屏) | Vue 3 · ECharts/ANTV/Three | 21 |
| html5-games | H5 游戏厅(79 款小游戏,构建期注册表 + GameShell 统一外壳) | Vue 3 · Vite · TS | 21 |
| nas-console | NAS 服务管理台(服务健康监控 + Umami 访问分析,单容器双角色) | React · Vite · Node 22 · SQLite | 21 |
| xiaoye-admin-react | 后台管理框架(菜单即路由、OpenAPI 契约三对齐、NAS 一键部署) | Vite · React · Tailwind · Ant Design · MSW | 21 |
| 项目 | 定位 | 技术栈 | 篇数 |
|---|---|---|---|
| react-ui | React 组件库(83 hooks + 130 组件 + pro 三层可发布包) | React 19 · TypeScript · Vite 库模式 · Playwright | 21 |
| my-ts-axios | TypeScript 从零实现 axios(浏览器 xhr + Node http + fetch 三适配器) | TypeScript · Rollup · Jest | 21 |
| vitest-playground | Vitest 可视化学习平台(服务端沙箱执行测试,防篡改判题) | Vite · React · Vitest 编程式 API · Monaco | 21 |
| devtools | 开发者工具箱(18 册既有文档集,含全工具速查矩阵) | Vue 3 · Vite · Element Plus | 18 |
00-项目总览(约 10 分钟)。00 → 01 → 02 → 05 → 06 顺序读基础篇;深入某模块查 07-模块详解。03-接口设计 + 15-接口全量参考(全量速查)+ 19-数据契约与示例集(可重放示例)。16-决策记录ADR(每条决策含备选方案与代价)。08-安全与权限设计 + 13-技术债务与演进建议。10-性能设计与优化。11-扩展开发指南 的 SOP。12-FAQ与故障排查(决策树 + FAQ)。18-代码走读实录(核心文件逐段精读)与 20-术语表。17-依赖全景(grep 证据 + 健康度评估)。20-术语表与文档索引 的反向索引。.env.* 含真实 Key、已内嵌进 dist 构建产物、git 历史提交 c5f41bd 亦有。建议轮换 → 改代理 → 清理历史。详见 PEXELS/08-安全与权限设计。PATCH /api/solutions/[id]/upvote 无鉴权可刷赞;GET /api/test-papers/[id] 公开返回答案;done 后回源接口实为 405(前后端契约断点)。env.production.template 含真实 MinIO 密钥。backup-db.sh 防呆方向反了(一行可修)。db:seed 清空 11 表无护栏,生产严禁。auth.admin.json 明文口令暂存;events 表无裁剪;as ProbeEvent[] 类型断言运行时失真。run-local.sh 明文密钥;WebDAV PUT/MKCOL/MOVE/COPY 均 501 且部分未注册路由。POST /api/auth/me 标 @Public() 致 cookie 回退通道恒 null(⚠️ 待确认);当前 JSON 实测 750 条与文档基线 1057 条不一致(疑经历去重合并)。/api/admin/stock-log/page 端点。klona、xiaoye-admin-react qs/react-transition-group。对除 html5-dataviz 外的 17 个项目做了全文档集一致性回刷:以加厚篇(16-20)发现的矛盾点为线索,逐点回源验证后最小化修订失实旧篇(共修订约 130 处、涉及 130+ 个文件),并同步清理新篇中的"建议修订"标注。回刷中的重要新发现:
code===0 && res.data,而命中响应无 data),秒传退化为全量重传且可能触发唯一键冲突;移动端无此问题。/api/public/metrics 的 502 透传 panelMsg 属真实信息泄露面(面板 host:port 可能到达公开面)。54429841 把示例库从 1057 条并为 750 条,全文档集计数已按"当前 750(历史基线 1057)"回刷;另发现 /admin 后台仍消费 examples 模块(模块瘦身前须先处置)。SERVICE_KIND 实有消费方。回刷方法与边界:每项目一个代理,只做最小化点状修订(保持结构与文风),源码全程只读;未发现任何项目在回刷期间有新的源码变更(html5-examples 的漂移发生在回刷开始前并已被捕获)。
01-系统架构、05-核心流程、15-接口全量参考。