oh-my-muse/design-docs/00-文档大纲.md
zizi 0d0e1d4473 添加产品设计文档
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent)

Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
2026-05-20 10:38:31 +08:00

9.3 KiB
Raw Blame History

New-Design新设计V2 文档大纲(入口)

  • 版本v5
  • 更新日期2026-05-19
  • 目标读者:产品 / 架构 / 前端 / 后端 / 文档维护者
  • 阅读时间1020 分钟
  • 边界说明:本文件只负责导航、边界和归属,不重复解释概念;概念解释必须落在对应主文档中。

目标

  • 形成一套按角色拆分、单一归属、可持续维护的设计文档集。
  • 明确“产品闭环、系统流程、实现约束”分别由谁负责,不允许多份文档各说各话。

文档集规则(别制造特殊情况)

  • 角色前缀 + 扁平结构:文件名即归属,避免目录层级变成垃圾桶。
  • 跨文档复用内容只允许“链接 + 一句话摘要”,禁止大段复制粘贴。
  • 术语统一:规范数据(Canonical) / 待审层(Shadow) / 作品(Work) / 章节(Chapter) / 文本块(Block) / 元结构定义(MetaSchema) 等,以 架构-02-核心数据结构与双轨模型.md 为准。
  • 临时改造文档只作为迁移依据;临时文档删除后,正式归属由 产品-*流程-*架构-*前端-*后端-*doc/dev/* 承担,不成为长期单一事实源(Single Source of Truth, SSOT)。

角色视角导航

角色视角 先读 再读 边界
管理员控制台(Admin Console) 产品-02-核心功能与交互边界架构-01-系统全貌与边界上下文 后端-05-统一API契约-v1前端-01-工程结构与核心依赖流程-02-系统处理流程(系统视角) 管理系统能力、全局知识、权限、审计和评测,不替普通用户做单作品创作取舍。
普通用户工作区(User Workspace) 产品-02-核心功能与交互边界产品-03-用户旅程与操作流程流程-01-产品操作流程(用户视角) 前端-01-工程结构与核心依赖前端-02-编辑器与影子层交互前端-03-元引擎与动态表单后端-05-统一API契约-v1 包含我的作品(My Works)、单作品的作品工作台(Work Workspace)、写作台、作品规划台、知识与一致性、导入解析、导出交付、记录与用量;不承载管理员配置。
个人中心(Personal Center) 产品-02-核心功能与交互边界前端-01-工程结构与核心依赖后端-05-统一API契约-v1 doc/dev/01-总体路线图与阶段依赖doc/dev/09-验收口径与退出条件 管理个人信息、令牌(Token)使用、配额、套餐、生成记录总览和授权摘要;不承载单作品深层创作或系统后台配置。

快速导航(按文档职责)

产品

  1. 产品-01-产品定位与核心价值
  2. 产品-02-核心功能与交互边界
  3. 产品-03-用户旅程与操作流程
  4. 需要按步骤执行时:流程-01-产品操作流程(用户视角)

导入与全书解析相关内容只做归属,不多处重写:

  • 产品边界:产品-02-核心功能与交互边界.md
  • 用户步骤:流程-01-产品操作流程(用户视角).md
  • 系统链路:流程-02-系统处理流程(系统视角).md
  • 模型与边界:架构-02-核心数据结构与双轨模型.md
  • 接口与事务:后端-05-统一API契约-v1.md
  • 前端一致性:前端-02-编辑器与影子层交互.md

架构

  1. 架构-01-系统全貌与边界上下文
  2. 架构-02-核心数据结构与双轨模型
  3. 架构-03-关键决策与原则(ADR)
  4. 架构-04-状态机与约束清单

后端

  1. 后端-01-领域模型与聚合设计
  2. 后端-02-工程结构与模块职责
  3. 后端-03-关键流程实现与接口契约
  4. 后端-04-统一数据库Schema-v1
  5. 后端-05-统一API契约-v1
  6. 系统链路参考:流程-02-系统处理流程(系统视角).md

前端

  1. 前端-01-工程结构与核心依赖
  2. 前端-02-编辑器与影子层交互
  3. 前端-03-元引擎与动态表单

流程

专题补充

说明:专题文档只负责跨文档收束,不抢走 Schema、状态机和统一 API 的单一归属。

输入 / 输出闭环(你写的东西要能被别人用)

文档 输入(来自哪里) 输出(给谁用)
产品-01 业务目标 / 用户画像 / 产品战略 产品定位、价值主张、产品闭环、非目标
产品-02 需求 / 约束 / 交互取舍 功能边界、决策模型、失败反馈边界
产品-03 用户旅程 / 长期使用方式 单次创作闭环、长期作品闭环、关键决策点
架构-01 需求边界 / 有界上下文 系统全貌、上下文边界、协作规则
架构-02 核心概念 / 数据结构 双轨模型、数据不变式、模型级规则
架构-03 关键权衡 架构决策记录与原则
架构-04 结构定义 / 接口决策收束 生命周期、表级约束、端点前后置条件
后端-01 架构模型 / 有界上下文规则 聚合、实体、不变式
后端-02 工程约束 / 交付方式 模块职责、目录结构、依赖方向
后端-03 系统流程 / 外部集成 事务边界、事件边界、调用链路
后端-04 双轨模型与接口基线 数据库表结构、索引、迁移约束
后端-05 统一资源语义 API 契约、异步模式、错误模型
前端-01 产品边界 / 工程约束 前端结构、依赖、目录策略
前端-02 双轨交互规则 编辑器与待审层协作、回滚与刷新策略
前端-03 元结构驱动规则 动态表单与渲染链路
流程-01 产品步骤 / 决策点 用户步骤、可观察反馈、恢复路径
流程-02 架构数据流规则 系统阶段链路、场景编排、数据约束
专题-01 已确认的跨文档决策 Accept Suggestion 的统一收束稿
专题-02 外部竞品调研 / 产品取舍判断 Sudowrite 对标、Muse 优劣势、该学什么与不该学什么
专题-03 doc/dev 中已经收敛为目标设计的 AI 编排缺口 RAGFlow、Graph Query Provider、上下文组装、Agent/Prompt、Risk Routing、质量评测和默认超级管理员初始化的跨文档实现规范
doc/dev/* 当前代码事实 / 阶段目标 / 正式设计归属 实现路线图、产品形态影响面、阶段验收门禁(Gate)、真实现状差距

单一归属清单(强制)

  • 双轨模型:架构-02-核心数据结构与双轨模型.md
  • 有界上下文与协作规则:架构-01-系统全貌与边界上下文.md
  • 架构决策记录:架构-03-关键决策与原则(ADR).md
  • 生命周期与状态机:架构-04-状态机与约束清单.md
  • 后端模块职责:后端-02-工程结构与模块职责.md
  • 产品旅程与长期闭环:产品-03-用户旅程与操作流程.md
  • 系统五阶段与场景编排:流程-02-系统处理流程(系统视角).md
  • AI 编排、检索上下文和质量评测跨文档合同:专题-03-AI编排上下文与质量评测实现规范.md
  • 统一数据库表结构:后端-04-统一数据库Schema-v1.md
  • 统一接口契约:后端-05-统一API契约-v1.md
  • 产品形态与信息架构门禁:doc/dev/01-总体路线图与阶段依赖.mddoc/dev/09-验收口径与退出条件.md

迁移说明

  • 映射表:内容映射表.md
  • 历史文档源:doc/new-design/(仅保留参考,不再作为当前设计单一事实源)
  • 临时改造文档:临时-新产品形态设计与文档改造说明.md 只作为本轮改造依据;正式文档更新后应可删除,删除后不保留为长期归属入口。