主题
如何使用本知识库
一句话:这里同时讲「产品是什么」和「它是怎么用代码实现的」,两边用同一套功能点 ID 对齐。
1. 这本书分五层
| 层 | 目录 | 回答的问题 |
|---|---|---|
| 指南 | guide/ | 怎么读、术语什么意思 |
| 产品层 | product/ | 有哪些能力、给谁用、领域模型是什么 |
| PM 专题 | pm-domain/ | 项目管理方法论如何落到本平台功能上 |
| 模块手册 | modules/ | 每个后端模块管什么、有哪些表与接口 |
| 代码层 | code/ + cards/ | 某个功能在哪个类、哪张表、哪条链路 |
2. 三种查法
- 按功能找代码:打开功能卡(
cards/SYS-USER-01),看「代码定位」小节。 - 按代码找功能:查 索引-按代码找功能(由脚本生成,反查 Controller/DO 对应的功能卡)。
- 按模块浏览:从 模块手册总览 进入。
- 看一次完整走读:从功能到代码 用「新增用户」把六层串了一遍,适合第一次做端到端定位。
3. 状态标记
| 标记 | 含义 | 是否能跑 |
|---|---|---|
| ✅ | 后端已实现,参与 Maven 构建 | 能 |
| ⏸ | 代码在库、未接入 pmforge-server 运行时(其中 12 个已纳入构建并编译通过,ai 暂不构建) | 需接入运行时:补 DDL、菜单与配置 |
| 🚧 | 规划中,尚无代码 | 不能 |
4. 阅读前你需要知道
- 当前只有
system与infra两个模块参与构建,其余 13 个模块是预留资产,未随主流程验证。 - 数据层以 MySQL 为基准描述,其它 9 种数据库的差异见 依赖与版本。
- 知识库与代码的一致性由
npm run docs:check在 CI 里守护,生成物过期即构建失败。
5. 从这里开始
| 你是 | 先读 | 再读 |
|---|---|---|
| 产品 / PM | 产品定位 | 能力地图 → 角色与场景 |
| 刚接手代码 | 阅读路径 的路径 B | 模块手册:system → 横切机制 |
| 想动手 | 练习与自测 练习 1 | 从功能到代码 → 接口索引 找到权限点再回代码 |
| 卡住了 | 术语表 | 常见问题 |
| 要找某个功能 | 功能卡索引 | 索引-按代码找功能 |
6. 本地运行知识库
bash
npm install # 首次
npm run docs:dev # 本地预览,默认 http://localhost:5173
npm run docs:gen # 重新生成接口索引 / 数据字典 / 配置项 / 枚举 / 功能卡
npm run docs:check # CI 用:生成物过期或 front-matter、链接、代码引用不合法即失败
npm run docs:build # 产出 docs/.vitepress/dist