You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
4.4 KiB
4.4 KiB
| name | overview | todos | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| docs-merge-refactor | 将docs目录下04-08文档合并精简为3个文件：开发与测试规范、接口规范、项目技术要求，删除核心数据模型和TAPD需求拆解两个延后文档 |
|
产品概述
将医院后勤管理项目的文档体系从5个文件(04-08)精简为3个文件，优先整理开发规范和技术要求，延后数据模型设计。
核心功能
- 删除
04-核心数据模型.md和07-TAPD需求拆解.md（延后处理） - 新建
04-开发与测试规范.md，包含：Git分支/提交规范、代码风格规范、测试规范、前后端协作规范、CI/CD流程规范 - 合并
05-API接口规范.md+06-扩展接口规范.md为05-接口规范.md - 将
08-项目技术要求.md重命名为06-项目技术要求.md
最终文档结构
docs/
├── 01-模块划分.md
├── 02-功能清单-超级管理员.md
├── 02-功能清单-物业公司.md
├── 02-功能清单-医院.md
├── 02-功能清单-小程序端.md
├── 03-业务流转逻辑-超级管理员.md
├── 03-业务流转逻辑-物业公司.md
├── 03-业务流转逻辑-医院.md
├── 03-业务流转逻辑-小程序端.md
├── 04-开发与测试规范.md ← 新建
├── 05-接口规范.md ← 原05+06合并
└── 06-项目技术要求.md ← 原08重命名
技术栈
纯文档整理任务，无代码技术栈依赖。文档内容基于现有项目技术栈（Java 17 + Spring Boot 3 + Vue 3 + uni-app）。
实现方案
1. 新建 04-开发与测试规范.md
从08-项目技术要求.md第七章"开发规范"和第九章"测试要求"中提取相关内容，并大幅扩展为独立文档，包含5大板块：
- Git分支与提交规范：分支策略（已有框架）、Commit Message规范（Conventional Commits）、分支保护规则、Merge Request流程
- 代码风格规范：后端Java规范（基于08第七章7.3命名规范扩展）、前端Vue/TypeScript规范、小程序uni-app规范、ESLint/Prettier配置
- 测试规范：单元测试（JUnit5+Mockito）、集成测试、E2E测试、测试覆盖率要求（从08第九章提取并细化）
- 前后端协作规范：API联调流程、接口文档管理（Swagger）、Mock数据规范、联调排期约定
- CI/CD流程规范：Jenkins/GitLab CI流水线配置、构建-测试-部署各阶段门禁、环境管理策略（从08第十章提取）
2. 合并 05+06 为 05-接口规范.md
- 05-API接口规范.md 作为主体，保持原有结构不变
- 06-扩展接口规范.md 作为新章节追加到主体末尾，章节号顺延
- 合并后结构：一~十七（原05内容）+ 十八~二十七（原06内容，章节号重编）
- 删除原06中与05重复的全局约定内容
3. 重命名 08 → 06-项目技术要求.md
- 内容基本不变，但需移除已拆分到04的开发规范和测试规范章节（改为引用04）
- 更新文档内引用路径（如"详见06-扩展接口规范.md"改为"详见05-接口规范.md"）
4. 删除旧文件
- 删除 04-核心数据模型.md
- 删除 05-API接口规范.md
- 删除 06-扩展接口规范.md
- 删除 07-TAPD需求拆解.md
- 删除 08-项目技术要求.md
实施注意事项
- 04-开发与测试规范.md 的内容应与08-项目技术要求.md 中的开发/测试章节保持一致，04独立后08中对应章节改为引用
- 合并接口规范时保持原有API路径、请求体、响应体格式不变，仅做章节编号调整
- 08重命名为06后，内部引用路径需同步更新