init: 项目初始提交 - NeoZQYY Monorepo 完整代码
This commit is contained in:
25
docs/README.md
Normal file
25
docs/README.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# docs/
|
||||
|
||||
## 作用说明
|
||||
|
||||
项目文档中心,存放产品需求、技术架构、数据契约、运维手册、审计记录等所有文档资产。
|
||||
|
||||
## 内部结构
|
||||
|
||||
- `prd/` — 产品需求文档
|
||||
- `contracts/` — 数据契约
|
||||
- `openapi/` — OpenAPI 规范
|
||||
- `schemas/` — JSON Schema
|
||||
- `data_dictionary/` — 数据字典
|
||||
- `permission_matrix/` — 权限矩阵
|
||||
- `architecture/` — 架构设计文档
|
||||
- `database/` — 数据库设计与变更文档
|
||||
- `h5_ui/` — 小程序原型与 UI 设计稿
|
||||
- `ops/` — 运维手册
|
||||
- `audit/` — 审计记录(AI 变更日志)
|
||||
- `roadmap/` — 路线图
|
||||
|
||||
## Roadmap
|
||||
|
||||
- 补充 ADR(架构决策记录)模板
|
||||
- 完善数据字典,覆盖所有 schema 表字段
|
||||
Reference in New Issue
Block a user