微信小程序页面迁移校验之前 P5任务处理之前
This commit is contained in:
@@ -1,6 +1,7 @@
|
||||
# NeoZQYY 文档地图
|
||||
|
||||
> 本文档记录项目中所有文档资产的位置、类型和内容概要,方便快速定位。
|
||||
> 归档规则见末尾「文档归档规则」章节;程序输出路径规范见 `docs/deployment/EXPORT-PATHS.md`。
|
||||
|
||||
---
|
||||
|
||||
@@ -20,7 +21,6 @@
|
||||
| 文件 | 内容 |
|
||||
|------|------|
|
||||
| `docs/README.md` | 项目架构图、模块文档索引、技术栈速览、认证体系概览、四库架构、常用命令 |
|
||||
| `docs/etl-feiqiu-architecture.md` | ETL Connector 整体架构说明 |
|
||||
|
||||
### 2.2 数据库变更手册 `docs/database/`
|
||||
|
||||
@@ -29,6 +29,7 @@
|
||||
| 文件 | 记录内容 |
|
||||
|------|----------|
|
||||
| `BD_Manual_auth_tables.md` | auth Schema 8 张认证表(users、roles、permissions、user_applications 等) |
|
||||
| `BD_Manual_biz_tables.md` | biz Schema 4 张核心业务表(coach_tasks、coach_task_history、notes、trigger_jobs) |
|
||||
| `BD_Manual_auth_biz_schemas.md` | auth + biz Schema 创建 |
|
||||
| `BD_Manual_fdw_etl_setup.md` | FDW 跨库访问配置(zqyy_app → etl_feiqiu) |
|
||||
| `BD_Manual_app_schema_rls_views.md` | app Schema RLS 视图 |
|
||||
@@ -46,25 +47,28 @@
|
||||
| `BD_Manual_assistant_accounts_master.md` | 助教账户主表 |
|
||||
| `BD_Manual_assistant_service_records.md` | 助教服务记录表 |
|
||||
| `BD_Manual_site_tables_master.md` | 门店台桌主表 |
|
||||
| `BD_Manual_20260301_cleanup_and_fixes.md` | 已删除表残留清理 + ODS 商品销售窗口修复 + dim_staff_ex 列名修复 |
|
||||
| `README.md` | 数据库文档目录说明 |
|
||||
|
||||
子目录:
|
||||
|
||||
| 目录 | 内容 |
|
||||
|------|------|
|
||||
| `ddl/` | 9 个 DDL 基线文件,覆盖 etl_feiqiu 六层 Schema(meta/ods/dwd/core/dws/app)+ zqyy_app 两个 Schema(auth/public)+ FDW |
|
||||
| `ddl/` | 10 个 DDL 基线文件,覆盖 etl_feiqiu 六层 Schema(meta/ods/dwd/core/dws/app)+ zqyy_app 三个 Schema(auth/biz/public)+ FDW |
|
||||
| `_archived/` | 10 个已归档的历史变更文档(已废弃的表、已回滚的变更等) |
|
||||
|
||||
### 2.3 审计记录 `docs/audit/`
|
||||
|
||||
项目变更的完整审计追踪体系。
|
||||
项目变更的完整审计追踪体系。审计追溯链:Prompt 日志 ↔ Session 日志 ↔ 变更审计记录,通过 Prompt-ID 和 Session-ID 双向关联。
|
||||
|
||||
| 路径 | 内容 |
|
||||
|------|------|
|
||||
| `audit_dashboard.md` | 审计仪表盘,汇总所有变更审计记录 |
|
||||
| `README.md` | 审计目录说明 |
|
||||
| `changes/` | 31 份变更审计文档(`YYYY-MM-DD__<slug>.md` 格式),每份包含:变更原因、影响范围、回滚策略、验证 SQL |
|
||||
| `SESSION-LOG-GUIDE.md` | Session 日志使用指南:索引字段说明、查询方法、典型场景、与其他审计产物的关系 |
|
||||
| `changes/` | 38 份变更审计文档(`YYYY-MM-DD__<slug>.md` 格式),每份包含:变更原因、影响范围、回滚策略、验证 SQL |
|
||||
| `prompt_logs/` | ~500 份 Prompt 日志(`prompt_log_YYYYMMDD_HHMMSS.md`),记录每次 AI 交互的输入输出 |
|
||||
| `session_logs/` | 全量会话记录(按 `YYYY-MM/DD/` 分层),含双索引(`_session_index.json` / `_session_index_full.json`)、每轮 execution 的完整 Markdown 记录、LLM 生成的操作摘要 |
|
||||
|
||||
### 2.4 数据契约 `docs/contracts/`
|
||||
|
||||
@@ -105,7 +109,29 @@ H5 静态原型页面,用于小程序 UI 设计参考。
|
||||
| `js/` | 8 个交互脚本 |
|
||||
| `img/` | 图片资源 |
|
||||
|
||||
### 2.8 其他项目级文档目录
|
||||
### 2.8 参考资料 `docs/reference/`
|
||||
|
||||
| 文件 | 内容 |
|
||||
|------|------|
|
||||
| `bailian-agent-guide.md` | 百炼 Agent 集成参考指南(由 v1 + v2 合并) |
|
||||
| `bailian-dashscope-api.md` | 百炼 DashScope API 参考 |
|
||||
|
||||
### 2.9 数据分析报告 `docs/reports/`
|
||||
|
||||
一次性数据分析、调研产出的报告文档。与 `prd/specs/` 的区别:specs 是需求规格,reports 是基于数据的分析结论。
|
||||
|
||||
| 文件 | 内容 |
|
||||
|------|------|
|
||||
| `complex-orders-analysis.md` | 复杂订单结构分析(ODS 全量扫描,关联键与复杂度定义) |
|
||||
| `dwd-amount-duration-calibration.md` | DWD 层金额·绩效·时长字段口径全景(置信度与存疑项标注) |
|
||||
|
||||
### 2.10 架构文档 `docs/architecture/`
|
||||
|
||||
| 文件 | 内容 |
|
||||
|------|------|
|
||||
| `etl-feiqiu-architecture.md` | ETL Connector 整体架构说明(数据流、DWS/INDEX 任务、调度编排、CLI) |
|
||||
|
||||
### 2.11 其他项目级文档目录
|
||||
|
||||
| 路径 | 内容 |
|
||||
|------|------|
|
||||
@@ -117,7 +143,6 @@ H5 静态原型页面,用于小程序 UI 设计参考。
|
||||
| `docs/ops/` | 运维文档(预留,待填充) |
|
||||
| `docs/permission_matrix/` | 权限矩阵(预留,待填充) |
|
||||
| `docs/spec-input/2026-02-22__etl-aggregation-fix-spec-input.md` | ETL 聚合修复的 Spec 输入文档 |
|
||||
| `docs/etl-feiqiu-architecture.md` | ETL Connector 整体架构说明 |
|
||||
|
||||
|
||||
---
|
||||
@@ -128,8 +153,8 @@ H5 静态原型页面,用于小程序 UI 设计参考。
|
||||
|
||||
| 文件 | 内容 |
|
||||
|------|------|
|
||||
| `README.md` | 架构概览、双库连接、认证系统、13 个路由模块摘要、服务层、配置加载 |
|
||||
| `docs/API-REFERENCE.md` | 完整 API 参考:13 个路由模块的所有端点、请求/响应示例、认证要求、错误码 |
|
||||
| `README.md` | 架构概览、双库连接、认证系统、17 个路由模块摘要、服务层、配置加载、触发器系统 |
|
||||
| `docs/API-REFERENCE.md` | 完整 API 参考:17 个路由模块的所有端点、请求/响应示例、认证要求、错误码 |
|
||||
|
||||
### 3.2 ETL Connector `apps/etl/connectors/feiqiu/`
|
||||
|
||||
@@ -150,13 +175,14 @@ H5 静态原型页面,用于小程序 UI 设计参考。
|
||||
|
||||
| 文件 | 内容 |
|
||||
|------|------|
|
||||
| `README.md` | 后端 API 集成、认证流程、权限模型、关键端点说明 |
|
||||
| `README.md` | 后端 API 集成、认证流程(含开发模式)、权限模型、关键端点说明 |
|
||||
| `doc/auth-integration-guide.md` | 认证集成详细指南 |
|
||||
|
||||
### 3.4 管理后台 `apps/admin-web/`
|
||||
|
||||
| 文件 | 内容 |
|
||||
|------|------|
|
||||
| `README.md` | 8 个页面、组件体系、API 层、状态管理、开发指南 |
|
||||
| `README.md` | 8 个页面、组件体系(含营业日提示)、API 层、状态管理、开发指南 |
|
||||
|
||||
### 3.5 MCP Server `apps/mcp-server/`
|
||||
|
||||
@@ -168,7 +194,7 @@ H5 静态原型页面,用于小程序 UI 设计参考。
|
||||
|
||||
| 文件 | 内容 |
|
||||
|------|------|
|
||||
| `README.md` | 3 个模块(enums / money / datetime_utils)的 API 文档及用法示例 |
|
||||
| `README.md` | 4 个模块(enums / money / datetime_utils / 其他工具)的 API 文档及用法示例 |
|
||||
|
||||
---
|
||||
|
||||
@@ -227,4 +253,38 @@ H5 静态原型页面,用于小程序 UI 设计参考。
|
||||
| `spi-spending-power-index` | SPI 消费力指数 |
|
||||
| `dataflow-field-completion` | 数据流字段补全 |
|
||||
| `dataflow-structure-audit` | 数据流结构审计 |
|
||||
| `assistant-abolish-cleanup` | 助教废除清理 |
|
||||
| `assistant-abolish-cleanup` | 助教废除清理 |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 六、文档归档规则
|
||||
|
||||
新建文档时,按以下规则选择目标目录。禁止在 `docs/` 根目录散放文件(`README.md` 和 `DOCUMENTATION-MAP.md` 除外)。
|
||||
|
||||
| 文档类型 | 目标目录 | 说明 |
|
||||
|----------|----------|------|
|
||||
| 数据分析报告、调研产出 | `reports/` | 一次性分析结论,带"生成时间/数据来源"标记 |
|
||||
| 架构设计文档 | `architecture/` | 系统/模块架构图与说明 |
|
||||
| 数据库变更审计 | `database/` | `BD_Manual_*.md` 格式,含回滚与验证 SQL |
|
||||
| 变更审计记录 | `audit/changes/` | `YYYY-MM-DD__<slug>.md` 格式 |
|
||||
| 产品需求规格 | `prd/specs/` | P1-P11 等需求 spec,不放分析报告 |
|
||||
| 数据契约 | `contracts/` | OpenAPI spec、JSON Schema、数据字典 |
|
||||
| 部署与运维配置 | `deployment/` | 启动清单、路径规范、安全指南 |
|
||||
| 路线图与规划 | `roadmap/` | 迁移计划、BACKLOG |
|
||||
| Spec 需求输入 | `spec-input/` | 问题汇总,供开启 Spec 流程 |
|
||||
| 外部参考资料 | `reference/` | 第三方 API/SDK 指南 |
|
||||
| 迁移记录 | `migrate/` | 仓库迁移总结、配置迁移记录 |
|
||||
| MCP 相关 | `mcp/` | AI 工具集成文档 |
|
||||
| UI 原型 | `h5_ui/` | H5 静态原型页面 |
|
||||
| 运维手册 | `ops/` | 故障排查、日常运维流程 |
|
||||
| 权限矩阵 | `permission_matrix/` | 角色-资源权限映射 |
|
||||
|
||||
### 判断流程
|
||||
|
||||
1. 是模块专属文档?→ 放模块内部 `docs/`(如 `apps/etl/.../docs/`)
|
||||
2. 是审计产物?→ 统一写 `docs/audit/`,禁止写入子模块
|
||||
3. 按上表匹配文档类型 → 放对应子目录
|
||||
4. 都不匹配?→ 先在上表新增分类,再创建子目录
|
||||
|
||||
> 本规则由 `.kiro/steering/export-paths.md` 强制执行。
|
||||
|
||||
Reference in New Issue
Block a user