diff --git a/README.md b/README.md index dd0a194..24e750b 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,51 @@ ---- -tags: - - 规范/目录管理 - - 项目文档/README -aliases: - - 目录说明书 - - 文件管理手册 -created: 2026-01-20 -updated: 2026-01-20 -version: 2.1 ---- +# 产品管理文档知识库 -# 项目文件管理与目录说明手册 (V2.1) +> 医疗影像产品多产品线文档统一管理仓库 -> [!abstract] 核心目标 -> 本文档用于说明 **项目知识库中各目录的用途、边界和放置规则**。 +## 📁 仓库结构 -> [!IMPORTANT] 核心原则 (双轨制管理) -> * **工程态 (Engineering)**: 实际落地能力。 -> * **注册态 (Regulatory)**: 申报合规内容。 -> * **规划态 (Planning)**: 未来产品演进。 +``` +Product-Manage/ # Git 仓库根目录 +├── 医生端/ # 医疗影像医生端产品线文档 +├── 标注端/ # 医疗影像标注端产品线文档 +├── .gitignore # Git 忽略规则 +└── README.md # 本文件 +``` ---- +## 🎯 仓库说明 -## 一、整体目录结构 +本仓库采用 **多产品线并行管理** 模式，每个产品线拥有独立的文档体系。 + +### 医生端 + +医疗影像诊断医生工作站相关的全生命周期文档管理。 + +- **工程态 (Engineering)**: 实际研发落地的技术实现与验证 +- **注册态 (Regulatory)**: 医疗器械注册申报的合规文档 +- **规划态 (Planning)**: 未来版本的产品演进规划 + +**文档目录**: [医生端/](./医生端/) +**详细说明**: [医生端/README.md](./医生端/README.md) + +### 标注端 + +医疗影像数据标注平台相关的全生命周期文档管理。 + +**文档目录**: [标注端/](./标注端/) +**详细说明**: [标注端/README.md](./标注端/README.md)（待完善） + +## 📋 文档管理规范 + +### 统一原则 + +1. **双轨制管理**: 工程态（Engineering）与注册态（Regulatory）分离 +2. **版本化管理**: 按年度划分（2025/2026/2027...） +3. **模板化规范**: 各产品线共享核心模板标准 +4. **可追溯性**: PRD → 功能点 → 技术规格 → 测试用例全链路追溯 + +### 标准目录结构 + +每个产品线遵循统一的目录层级： ```text 00 模板中心 (全项目唯一模板源头) @@ -32,46 +55,57 @@ version: 2.1 04 产品 → 开发衔接 (功能点: 追溯枢纽) 05 开发与技术规格 (架构与实现) 06 算法与仿真 (算法原理与仿真验证) - ├─ 算法 - └─ 仿真 07 API 与接口文档 (接口契约) 08 测试与验证 (测试用例与报告) 09 生产部署与运维 (发布与运维SOP) 10 项目沉淀 (复盘与归档) ``` ---- +## 🚀 快速开始 -## 二、详细目录规范（部分展示） +### 新增产品线 -### 06 算法与仿真 -> 包含算法原理定义与仿真环境/方案验证。 +```bash +# 复制医生端结构作为模板 +cp -r 医生端/ 新产品线/ +cd 新产品线/ +# 根据实际情况调整目录和文档 +``` -#### 算法 -* `算法说明_2025_工程`: 实验过程、失败尝试、定型算法。 -* `算法说明_2025_注册`: 用于申报的定型算法原理。 -* `算法说明_2026_工程`: 新一代算法探索。 +### 常用操作 -#### 仿真 -* `仿真方案_2025_工程`: 研发过程中的仿真验证。 -* `仿真验证_2025_注册`: 申报用的仿真报告与结论。 -* `仿真方案_2026_工程`: 未来产品的仿真预研。 +```bash +# 查看某产品线的文档结构 +tree 医生端/ -L 2 + +# 搜索特定内容 +grep -r "关键词" 医生端/ + +# 提交变更 +git add . +git commit -m "docs: 更新文档描述" +git push +``` + +## 📖 相关文档 + +- [医生端文档管理手册](./医生端/README.md) +- [模板中心说明](./医生端/00%20模板中心/README.md) +- [标注端文档规划](./标注端/README.md) + +## 🔄 版本历史 + +| 版本 | 日期 | 说明 | +|------|------|------| +| 2.0 | 2026-01-21 | 重构为多产品线管理模式，医生端/标注端独立 | +| 1.0 | 2026-01-20 | 初始化医生端文档体系 | + +## 📧 联系方式 + +如有文档管理相关问题，请联系项目经理或文档管理员。 --- -## 三、文件放置快速判断规则 - -> [!example] 决策指南 -> * **这是“算法”相关内容吗？** -> * 是，且用于注册 -> `06 算法与仿真/算法/算法说明_2025_注册` -> * 是，且是实验记录 -> `06 算法与仿真/算法/算法说明_2025_工程` -> * **这是“仿真”相关内容吗？** -> * 是，且用于注册 -> `06 算法与仿真/仿真/仿真验证_2025_注册` -> * 是，且是研发验证 -> `06 算法与仿真/仿真/仿真方案_2025_工程` -> * **不确定放哪？** -> * 先放 `10 项目沉淀`，再咨询项目经理。 - ---- - -> [!warning] 声明 -> 本手册是 **文件管理规则**，所有成员必须遵循。 +**最后更新**: 2026-01-21 +**维护者**: 产品管理团队 +**仓库地址**: `ssh://git@git.qubit.ltd:10022/yangzhixin/njboea-product.git` diff --git a/00 模板中心/00.1PRD母版.md b/医生端/00 模板中心/00.1PRD母版.md similarity index 100% rename from 00 模板中心/00.1PRD母版.md rename to 医生端/00 模板中心/00.1PRD母版.md diff --git a/00 模板中心/00.2功能点拆解母版.md b/医生端/00 模板中心/00.2功能点拆解母版.md similarity index 100% rename from 00 模板中心/00.2功能点拆解母版.md rename to 医生端/00 模板中心/00.2功能点拆解母版.md diff --git a/00 模板中心/00.3API文档母版.md b/医生端/00 模板中心/00.3API文档母版.md similarity index 100% rename from 00 模板中心/00.3API文档母版.md rename to 医生端/00 模板中心/00.3API文档母版.md diff --git a/00 模板中心/00.4测试用例母版.md b/医生端/00 模板中心/00.4测试用例母版.md similarity index 100% rename from 00 模板中心/00.4测试用例母版.md rename to 医生端/00 模板中心/00.4测试用例母版.md diff --git a/00 模板中心/00.5发布与回滚母版.md b/医生端/00 模板中心/00.5发布与回滚母版.md similarity index 100% rename from 00 模板中心/00.5发布与回滚母版.md rename to 医生端/00 模板中心/00.5发布与回滚母版.md diff --git a/00 模板中心/00.6ADR决策记录母版.md b/医生端/00 模板中心/00.6ADR决策记录母版.md similarity index 100% rename from 00 模板中心/00.6ADR决策记录母版.md rename to 医生端/00 模板中心/00.6ADR决策记录母版.md diff --git a/00 模板中心/00.7会议纪要母版.md b/医生端/00 模板中心/00.7会议纪要母版.md similarity index 100% rename from 00 模板中心/00.7会议纪要母版.md rename to 医生端/00 模板中心/00.7会议纪要母版.md diff --git a/00 模板中心/README.md b/医生端/00 模板中心/README.md similarity index 100% rename from 00 模板中心/README.md rename to 医生端/00 模板中心/README.md diff --git a/医生端/README.md b/医生端/README.md new file mode 100644 index 0000000..dd0a194 --- /dev/null +++ b/医生端/README.md @@ -0,0 +1,77 @@ +--- +tags: + - 规范/目录管理 + - 项目文档/README +aliases: + - 目录说明书 + - 文件管理手册 +created: 2026-01-20 +updated: 2026-01-20 +version: 2.1 +--- + +# 项目文件管理与目录说明手册 (V2.1) + +> [!abstract] 核心目标 +> 本文档用于说明 **项目知识库中各目录的用途、边界和放置规则**。 + +> [!IMPORTANT] 核心原则 (双轨制管理) +> * **工程态 (Engineering)**: 实际落地能力。 +> * **注册态 (Regulatory)**: 申报合规内容。 +> * **规划态 (Planning)**: 未来产品演进。 + +--- + +## 一、整体目录结构 + +```text +00 模板中心 (全项目唯一模板源头) +01 项目总览 (项目背景与规则) +02 项目管理 (计划、风险、变更) +03 产品管理 (PRD: 区分工程/注册/规划) +04 产品 → 开发衔接 (功能点: 追溯枢纽) +05 开发与技术规格 (架构与实现) +06 算法与仿真 (算法原理与仿真验证) + ├─ 算法 + └─ 仿真 +07 API 与接口文档 (接口契约) +08 测试与验证 (测试用例与报告) +09 生产部署与运维 (发布与运维SOP) +10 项目沉淀 (复盘与归档) +``` + +--- + +## 二、详细目录规范（部分展示） + +### 06 算法与仿真 +> 包含算法原理定义与仿真环境/方案验证。 + +#### 算法 +* `算法说明_2025_工程`: 实验过程、失败尝试、定型算法。 +* `算法说明_2025_注册`: 用于申报的定型算法原理。 +* `算法说明_2026_工程`: 新一代算法探索。 + +#### 仿真 +* `仿真方案_2025_工程`: 研发过程中的仿真验证。 +* `仿真验证_2025_注册`: 申报用的仿真报告与结论。 +* `仿真方案_2026_工程`: 未来产品的仿真预研。 + +--- + +## 三、文件放置快速判断规则 + +> [!example] 决策指南 +> * **这是“算法”相关内容吗？** +> * 是，且用于注册 -> `06 算法与仿真/算法/算法说明_2025_注册` +> * 是，且是实验记录 -> `06 算法与仿真/算法/算法说明_2025_工程` +> * **这是“仿真”相关内容吗？** +> * 是，且用于注册 -> `06 算法与仿真/仿真/仿真验证_2025_注册` +> * 是，且是研发验证 -> `06 算法与仿真/仿真/仿真方案_2025_工程` +> * **不确定放哪？** +> * 先放 `10 项目沉淀`，再咨询项目经理。 + +--- + +> [!warning] 声明 +> 本手册是 **文件管理规则**，所有成员必须遵循。 diff --git a/标注端/README.md b/标注端/README.md new file mode 100644 index 0000000..dc47dda --- /dev/null +++ b/标注端/README.md @@ -0,0 +1,62 @@ +--- +tags: + - 规范/目录管理 + - 项目文档/README +aliases: + - 标注端目录说明 + - 标注端文档管理 +created: 2026-01-21 +updated: 2026-01-21 +version: 1.0 +--- + +# 标注端产品文档管理 + +> 医疗影像标注平台全生命周期文档知识库 + +## 📋 文档体系规划 + +本目录用于管理 **标注端产品线** 的所有项目文档，采用与医生端相同的文档管理规范。 + +## 🏗️ 目录结构（规划中） + +```text +标注端/ +├── 00 模板中心/ # 可复用医生端模板或自定义 +├── 01 项目总览/ # 产品背景、愿景、核心规则 +├── 02 项目管理/ # 计划、风险、变更记录 +├── 03 产品管理/ # PRD（按年度和工程/注册分类） +├── 04 产品 → 开发衔接/ # 功能点拆解表 +├── 05 开发与技术规格/ # 架构设计、技术规格 +├── 06 算法与仿真/ # 算法原理、仿真验证 +├── 07 API 与接口文档/ # API 清单与文档 +├── 08 测试与验证/ # 测试用例与测试报告 +├── 09 生产部署与运维/ # 发布记录、运维手册 +├── 10 项目沉淀/ # 会议纪要、决策记录、复盘 +└── README.md # 本文件 +``` + +## 📝 待办事项 + +- [ ] 根据医生端模板，建立标注端的目录结构 +- [ ] 确认标注端是否需要注册态管理 +- [ ] 导入现有标注端相关文档 +- [ ] 制定标注端特有的文档规范 + +## 🔗 参考文档 + +- [仓库根目录 README](../README.md) +- [医生端文档管理规范](../医生端/README.md) +- [医生端模板中心](../医生端/00%20模板中心/) + +## 📅 版本记录 + +| 版本 | 日期 | 说明 | +|------|------|------| +| 1.0 | 2026-01-21 | 创建标注端文档目录占位 | + +--- + +**状态**: 🚧 筹建中 +**负责人**: 待指定 +**最后更新**: 2026-01-21