微信小程序页面迁移校验之前 P5任务处理之前

This commit is contained in:
Neo
2026-03-09 01:19:21 +08:00
parent 263bf96035
commit 6e20987d2f
1112 changed files with 153824 additions and 219694 deletions

View File

@@ -1,16 +1,49 @@
---
inclusion: always
---
# 产出物路径规范(强制)
# 输出路径规范(强制)
Kiro 所有产出物分两类,各有归档规则,禁止随意散放。
## 核心原则
所有文件输出必须写入 `export/` 统一目录结构,通过 `.env` 环境变量控制路径。禁止在 `export/` 体系外自行创建输出目录。
## 一、程序输出(数据文件、日志、报告)
## 编码规则
1. 路径必须从 `.env` 读取,禁止硬编码任何目录结构(含绝对路径和相对路径)
2. 环境变量缺失时必须报错(`KeyError` / `RuntimeError`),禁止静默回退
3. 路径读取方式:`scripts/ops/``_env_paths.get_output_path()`ETL 核心用 `AppConfig.io.*`;独立脚本用 `os.environ.get()` + 显式报错
4. 新增输出类型:先在根 `.env` + `.env.template` 新增变量,再在代码中引用,同步更新 `docs/deployment/EXPORT-PATHS.md`
写入 `export/` 目录结构,路径从 `.env` 环境变量读取。禁止硬编码路径,禁止在 `export/` 外创建输出目录。
> 完整目录结构、环境变量映射表、新增场景检查清单见 `export-paths-full.md`fileMatch读到 `.env*` / `scripts/` / `export/` 文件时自动加载,也可 `#export-paths-full` 手动加载)。
### 规则
1. 环境变量缺失时必须报错(`KeyError` / `RuntimeError`),禁止静默回退
2. 读取方式:`scripts/ops/``_env_paths.get_output_path()`ETL 核心 → `AppConfig.io.*`;独立脚本 → `os.environ.get()` + 显式报错
3. 新增输出类型:先在 `.env` + `.env.template` 加变量,再更新 `docs/deployment/EXPORT-PATHS.md`
> 完整目录结构与映射表见 `export-paths-full.md`fileMatch 自动加载)。
## 二、文档产出markdown、设计文档、分析报告
写入 `docs/` 对应子目录,禁止在 `docs/` 根目录散放文件。
### 归档规则
| 文档类型 | 目标目录 | 示例 |
|----------|----------|------|
| 数据分析报告、调研产出 | `docs/reports/` | 复杂订单分析、字段口径全景 |
| 架构设计文档 | `docs/architecture/` | ETL 架构说明 |
| 数据库变更审计BD 手册) | `docs/database/` | `BD_Manual_*.md` |
| 变更审计记录 | `docs/audit/changes/` | `YYYY-MM-DD__<slug>.md` |
| 产品需求规格 | `docs/prd/specs/` | P1-P11 需求 spec |
| 数据契约OpenAPI/Schema | `docs/contracts/` | `backend-api.json` |
| 部署与运维配置 | `docs/deployment/` | 启动清单、路径规范 |
| 路线图与规划 | `docs/roadmap/` | 迁移计划、BACKLOG |
| Spec 需求输入 | `docs/spec-input/` | 问题汇总供开启 Spec |
| 外部参考资料 | `docs/reference/` | 第三方 API 指南 |
| 迁移记录 | `docs/migrate/` | Monorepo 迁移总结 |
| MCP 相关文档 | `docs/mcp/` | AI 查询手册 |
| UI 原型 | `docs/h5_ui/` | H5 静态页面 |
| 运维手册 | `docs/ops/` | 故障排查流程 |
| 权限矩阵 | `docs/permission_matrix/` | 角色-资源映射 |
### 禁止事项
- 禁止在 `docs/` 根目录直接创建 `.md` 文件(`README.md``DOCUMENTATION-MAP.md` 除外)
- 禁止将分析报告放入 `prd/specs/`specs 只放需求规格)
- 禁止将审计产物写入子模块内部(统一写 `docs/audit/`
- 模块专属文档放模块内部(如 `apps/etl/.../docs/`),不放 `docs/`
> 完整文档索引见 `docs/DOCUMENTATION-MAP.md`。