存量文档迁移记录.md 15 KB

历史文档盘点与迁移建议

内容
文档定位 基于 Docs as Code 生命周期规范,对现有 docs/ 历史文档进行分类、归属和迁移建议
生成日期 2026-06-17
依据 docs/文档中心.mddocs/governance/文档分类.mddocs/governance/元数据规范.mddocs/governance/生命周期流程.md
当前策略 已完成第一批元数据补充和第二批专题索引,暂不直接移动历史文件

1. 总体结论

当前 docs/ 下的历史文档主要问题不是“文档数量多”,而是缺少稳定主线:

  • 同一需求的需求文档、设计文档、接口文档、开发计划分散在多个目录。
  • 绝大多数历史文档没有 doc_idfeature_idtypestatus 等元数据。
  • 需求文档架构文档接口文档 目录按粗粒度类型堆放,无法表达需求生命周期。
  • 历史开发计划已迁入对应 docs/initiatives/<feature_id>/dev-progress/ 目录。
  • OpenAPI、接口说明、前端接入、后端技术设计之间有关联,但依赖关系只能靠文件名判断。
  • 存在 .DS_Store 等系统文件,后续可清理。

建议按“先索引、再补元数据、最后迁移”的方式整理:

  1. 建立本盘点文档,先形成全局视图。已完成。
  2. 为核心历史文档补 Front Matter,不移动文件。已完成第一批。
  3. 创建 docs/initiatives/<feature_id>/专题索引.md 作为专题索引。已完成第一批。
  4. 将历史文档在专题索引中关联起来。
  5. 确认没有外部链接依赖后,再分批移动文档。

2. 建议专题主线

2.1 FEAT-202605-001-ai-future-hospital-platform

定位:医梦 AI 未来医院总体方案、AI 中台二期三期、空海会议后的动线感知方案。

建议目录:

docs/initiatives/FEAT-202605-001-ai-future-hospital-platform/

建议纳入:

当前文档 建议类型 建议状态 说明
docs/initiatives/FEAT-202605-001-ai-future-hospital-platform/需求文档.md prd approved 总体业务和方案口径
docs/initiatives/FEAT-202605-001-ai-future-hospital-platform/概要设计.md outline-designdesign approved 二期三期技术方案和商业闭环设计
docs/initiatives/FEAT-202605-001-ai-future-hospital-platform/meeting-notes/空海会议动线感知影响说明.md meetingdesign approved 会议结论到需求、架构、接口的映射
docs/initiatives/FEAT-202605-001-ai-future-hospital-platform/research/感知动线视频脚本.md research draft 感知动线视频脚本,可作为展示材料
docs/initiatives/FEAT-202605-001-ai-future-hospital-platform/research/感知动线演示.html research draft 感知动线演示资产
docs/initiatives/FEAT-202605-001-ai-future-hospital-platform/assets/*.png assets 不适用 架构图和方案图,应被专题 README 引用

缺口:

  • 缺少标准 需求录入.md
  • 缺少专题 专题索引.md
  • 缺少明确的 测试计划.md测试结果.md
  • 若未来继续推进实现,应拆出更小的子 feature_id

2.2 FEAT-202606-001-unified-entry-client

定位:统一入口客户端、终端 Web Demo、挂号演示闭环、前后端联调契约。

建议目录:

docs/initiatives/FEAT-202606-001-unified-entry-client/

建议纳入:

当前文档 建议类型 建议状态 说明
docs/initiatives/FEAT-202606-001-unified-entry-client/需求文档.md prd approved 演示范围、关键流程和边界
docs/initiatives/FEAT-202606-001-unified-entry-client/详细设计.md outline-designdetailed-design approved 统一入口完整技术方案
docs/initiatives/FEAT-202606-001-unified-entry-client/design/前端工程启动指南.md detailed-design approved 前端工程结构和启动规范
docs/initiatives/FEAT-202606-001-unified-entry-client/前端接入指引.md apidetailed-design approved 前端接入、鉴权、SSE 和卡片约定
docs/initiatives/FEAT-202606-001-unified-entry-client/MVP接口契约.md api approved MVP 接口契约
docs/api/openapi/医梦AI中台开放平台接口-v1.2.openapi.yaml api approved OpenAPI 契约
docs/initiatives/FEAT-202606-001-unified-entry-client/对外接口联调基准.md api approved 对外接口联调基准
docs/initiatives/FEAT-202606-001-unified-entry-client/dev-progress/终端客户端MVP实施计划.md dev-progress implemented 终端客户端 MVP 实施计划
docs/initiatives/FEAT-202606-001-unified-entry-client/dev-progress/演示闭环纵向任务拆分.md dev-progress implemented 纵向任务拆分
docs/initiatives/FEAT-202606-001-unified-entry-client/dev-progress/终端Web演示实施计划.md dev-progress implemented 前端 Web Demo 实施计划
docs/initiatives/FEAT-202606-001-unified-entry-client/dev-progress/统一入口挂号演示实施计划.md dev-progress implemented 挂号演示闭环实施计划
docs/initiatives/FEAT-202606-001-unified-entry-client/design/终端Web演示设计.md design approved Web Demo UI 设计规格

缺口:

  • 缺少标准 需求录入.md
  • 缺少专题 专题索引.md 汇总索引。
  • 缺少统一的 测试计划.md测试结果.md,当前验证信息分散在开发计划中。
  • 建议为 OpenAPI 和 Markdown 接口文档建立明确主从关系:OpenAPI 为准,Markdown 记录联调说明。

2.3 FEAT-202606-002-fastgpt-integration

定位:FastGPT 作为医梦 AI Agent 实现层之一接入。

建议目录:

docs/initiatives/FEAT-202606-002-fastgpt-integration/

建议纳入:

当前文档 建议类型 建议状态 说明
docs/initiatives/FEAT-202606-002-fastgpt-integration/FastGPT接入技术方案.md outline-designdetailed-design reviewing 接入方案、边界和实现建议

缺口:

  • 缺少 需求录入.md需求文档.md
  • 缺少 ADR。该文档涉及外部系统接入和架构边界,建议补 ADR-202606-001-fastgpt-integration.md
  • 缺少接口契约文档。若接入已经进入实现,应补 接口说明.md 或适配器接口说明。
  • 缺少测试计划和测试结果。

2.4 FEAT-202606-003-sqlite-his-mock-mcp-tools

定位:SQLite Mock HIS、MCP Tool、挂号演示的工具链能力。

建议目录:

docs/initiatives/FEAT-202606-003-sqlite-his-mock-mcp-tools/

建议纳入:

当前文档 建议类型 建议状态 说明
docs/initiatives/FEAT-202606-003-sqlite-his-mock-mcp-tools/dev-progress/SQLite-HIS-Mock-MCP工具实施计划.md detailed-designdev-progress implemented SQLite HIS Mock 和 MCP Tools 实施计划

缺口:

  • 建议作为 FEAT-202606-001-unified-entry-client 的子专题关联。
  • 缺少 需求录入.md需求文档.md测试结果.md
  • 如果该能力后续会保留为正式 Mock HIS 工具,应补充 接口说明.md 和运行手册。

2.5 FEAT-202606-004-opd-triage-agent

定位:门诊分诊智能体 Prompt。

建议目录:

docs/initiatives/FEAT-202606-004-opd-triage-agent/

建议纳入:

当前文档 建议类型 建议状态 说明
docs/initiatives/FEAT-202606-004-opd-triage-agent/分诊智能体提示词.md prompt approved Dify 分诊智能体 System Prompt

缺口:

  • 缺少 需求录入.md,无法追溯 Prompt 需求来源。
  • 缺少 需求文档.md,需要明确适用科室、禁用行为、验收标准。
  • 缺少 测试计划.md测试结果.md,建议补充典型症状、红旗症状、多轮上下文测试集。

2.6 FEAT-202605-002-knowledge-base-frontend

定位:知识库管理模块前端页面生成提示词。

建议目录:

docs/initiatives/FEAT-202605-002-knowledge-base-frontend/

建议纳入:

当前文档 建议类型 建议状态 说明
docs/initiatives/FEAT-202605-002-knowledge-base-frontend/知识库管理前端提示词.md promptapi draft Vue 前端生成提示词,包含知识库 API 清单和页面结构

缺口:

  • 缺少需求来源和当前实现状态。
  • 文档同时包含 Prompt、API、前端页面设计,建议拆分为 需求文档.md接口说明.md详细设计.md 或保留为历史 Prompt 并补元数据。

3. 长期规范和工程治理文档

这些文档不应归入单个需求专题,建议迁移到长期目录。

当前文档 建议目标 建议类型 说明
docs/standards/AI中台工程约束.md docs/standards/AI中台工程约束.md standard 工程红线、模块边界、接口归属
docs/standards/工程规约生效说明.md docs/standards/工程规约生效说明.md standard 规约生效机制和架构测试说明
docs/architecture/legacy/历史架构违规基线.txt docs/architecture/legacy/历史架构违规基线.txt standard 历史违规基线
docs/architecture/legacy/历史基线治理计划.md docs/architecture/legacy/历史基线治理计划.md dev-progressstandard 历史基线治理计划
docs/agents/domain.md docs/agents/domain.md standard Agent 领域文档索引,保留原位
docs/agents/issue-tracker.md docs/agents/issue-tracker.md standard 本地议题追踪规范,保留原位
docs/agents/triage-labels.md docs/agents/triage-labels.md standard 议题标签规范,保留原位

缺口:

  • docs/standards/ 目录尚未创建。
  • 长期规范也应补 Front Matter,但通常不需要 feature_id
  • 历史基线治理若继续推进,可以单独创建一个治理专题。

4. 模板和治理文档

以下文档是当前 Docs as Code 体系本身的规范和模板,保留原位:

当前文档 类型 说明
docs/文档中心.md standard 生命周期总入口
docs/governance/文档分类.md standard 分类和编号规则
docs/governance/元数据规范.md standard 元数据规范
docs/governance/生命周期流程.md standard 生命周期流程
docs/templates/*.md 模板 生命周期文档模板

建议后续为 docs/governance/*.md 补充 Front Matter。

5. 建议迁移批次

第一批:只补元数据,不移动文件(已完成)

目标:降低风险,让 Agent 先能基于 doc_idtypestatus 检索。

优先文档:

  • docs/initiatives/FEAT-202605-001-ai-future-hospital-platform/需求文档.md:已补 PRD-202605-001
  • docs/initiatives/FEAT-202605-001-ai-future-hospital-platform/概要设计.md:已补 ODS-202606-001
  • docs/standards/AI中台工程约束.md:已补 STD-202605-001
  • docs/standards/工程规约生效说明.md:已补 STD-202605-002
  • docs/initiatives/FEAT-202606-001-unified-entry-client/需求文档.md:已补 PRD-202606-001
  • docs/initiatives/FEAT-202606-001-unified-entry-client/详细设计.md:已补 DDS-202606-001
  • docs/initiatives/FEAT-202606-001-unified-entry-client/MVP接口契约.md:已补 API-202606-001
  • docs/initiatives/FEAT-202606-001-unified-entry-client/对外接口联调基准.md:已补 API-202606-002
  • docs/initiatives/FEAT-202606-002-fastgpt-integration/FastGPT接入技术方案.md:已补 DDS-202606-002
  • docs/initiatives/FEAT-202606-004-opd-triage-agent/分诊智能体提示词.md:已补 PMT-202606-001
  • docs/initiatives/FEAT-202605-002-knowledge-base-frontend/知识库管理前端提示词.md:已补 PMT-202605-001
  • docs/initiatives/FEAT-202605-001-ai-future-hospital-platform/meeting-notes/空海会议动线感知影响说明.md:已补 MTG-202606-001
  • docs/initiatives/FEAT-202605-001-ai-future-hospital-platform/research/感知动线视频脚本.md:已补 RSH-202606-001
  • docs/initiatives/FEAT-202606-001-unified-entry-client/design/前端工程启动指南.md:已补 DDS-202606-003
  • docs/initiatives/FEAT-202606-001-unified-entry-client/前端接入指引.md:已补 API-202606-003
  • docs/initiatives/FEAT-202606-001-unified-entry-client/dev-progress/终端客户端MVP实施计划.md:已补 DEV-202605-001
  • docs/initiatives/FEAT-202606-001-unified-entry-client/dev-progress/演示闭环纵向任务拆分.md:已补 DEV-202606-001
  • docs/initiatives/FEAT-202606-001-unified-entry-client/dev-progress/终端Web演示实施计划.md:已补 DEV-202606-002
  • docs/initiatives/FEAT-202606-001-unified-entry-client/dev-progress/统一入口挂号演示实施计划.md:已补 DEV-202606-003
  • docs/initiatives/FEAT-202606-003-sqlite-his-mock-mcp-tools/dev-progress/SQLite-HIS-Mock-MCP工具实施计划.md:已补 DEV-202606-004
  • docs/initiatives/FEAT-202606-001-unified-entry-client/design/终端Web演示设计.md:已补 DES-202606-001

说明:docs/api/openapi/医梦AI中台开放平台接口-v1.2.openapi.yaml 是 OpenAPI 契约文件, 本批次未直接写入 Markdown Front Matter,避免改变接口契约结构;通过专题索引进行关联。

第二批:建立专题索引(已完成)

目标:不移动历史文档,只创建 docs/initiatives/<feature_id>/专题索引.md,把现有文档挂进去。

建议先建:

  • FEAT-202605-001-ai-future-hospital-platform
  • FEAT-202605-002-knowledge-base-frontend
  • FEAT-202606-001-unified-entry-client
  • FEAT-202606-002-fastgpt-integration
  • FEAT-202606-003-sqlite-his-mock-mcp-tools
  • FEAT-202606-004-opd-triage-agent

第三批:补生命周期缺口

目标:为仍在推进的专题补齐关键文档。

优先补:

专题 优先补充
AI 未来医院总体方案 需求录入.md、专题 专题索引.md
统一入口客户端 专题 专题索引.md测试计划.md测试结果.md
FastGPT 接入 需求录入.md需求文档.md、ADR、测试计划.md
分诊智能体 需求文档.md测试计划.md测试结果.md

第四批:移动文件

目标:在确认没有外部链接依赖后,将历史文档逐步移动到新目录。

移动时应遵守:

  • 原位置保留迁移说明或索引链接。
  • PR 中明确列出旧路径和新路径。
  • 同步更新所有内部链接。
  • OpenAPI 文件移动前,确认生成脚本、前端 SDK、接口文档引用路径不会断。

6. 当前阶段判断

当前阶段:历史文档整理的“盘点阶段”。

已有文档:

  • Docs as Code 生命周期手册
  • 文档分类、元数据、生命周期规范
  • 多类生命周期模板
  • 本历史文档盘点与迁移建议
  • 第一批核心历史文档 Front Matter
  • docs/initiatives/ 专题索引

缺口:

  • 尚未为全部历史文档补 Front Matter。
  • 尚未为每个专题补齐 需求录入.md测试计划.md测试结果.md 等生命周期缺口。
  • 尚未建立 docs/standards/docs/api/ 新目录。
  • 尚未处理 .DS_Store 等非文档文件。

下一步:

  1. 为仍在推进的专题补 需求录入.md测试计划.md测试结果.md
  2. 为剩余历史文档补 Front Matter。
  3. 建立 docs/standards/docs/api/ 新目录,但移动前先确认引用。
  4. 最后决定是否移动旧目录中的文件。

警示:

不要直接大规模移动历史文档。当前很多文档互相引用旧路径,直接移动会破坏现有链接和 Agent 读取习惯。