1.5 KiB
1.5 KiB
inclusion, name, description
| inclusion | name | description |
|---|---|---|
| manual | doc-map | 项目文档地图索引。需要定位文档、理解项目结构、查找规范时手动加载。 |
文档地图索引
完整文档地图:#[[file:docs/DOCUMENTATION-MAP.md]]
快速定位
| 需要什么 | 去哪里找 |
|---|---|
| DB 变更审计模板 | docs/database/BD_Manual_*.md |
| API 端点参考 | apps/backend/docs/API-REFERENCE.md |
| ETL 任务说明 | apps/etl/connectors/feiqiu/docs/etl_tasks/ |
| ETL 业务规则 | apps/etl/connectors/feiqiu/docs/business-rules/ |
| 输出路径规范 | docs/deployment/EXPORT-PATHS.md |
| 上线检查清单 | docs/deployment/LAUNCH-CHECKLIST.md |
| 变更审计记录 | docs/audit/changes/ |
| PRD / Spec 拆分 | docs/prd/specs/ |
| 小程序 UI 原型 | docs/h5_ui/pages/ |
| 迁移脚本 | db/etl_feiqiu/migrations/ + db/zqyy_app/migrations/ |
| DDL 基线 | docs/database/ddl/ |
| 模块 README | 各 apps/*/README.md + packages/shared/README.md + db/README.md |
| Kiro Spec | .kiro/specs/<spec-name>/ (requirements + design + tasks) |
行为规范提示
- 新增 DB 表/字段 → 必须写
BD_Manual_*.md(见db-docs.mdsteering) - 新增输出路径 → 先加
.env变量,再更新EXPORT-PATHS.md(见export-paths.mdsteering) - 逻辑改动 → 审计由 hooks 自动检测提醒,按需触发
/audit - 新增/修改 API → 同步更新
API-REFERENCE.md - 新增 ETL 任务 → 同步更新
docs/etl_tasks/对应文档