zizi 0260bcd8e2 设计文档:SoT 同步与生成物重出
- 新版设计各域 SoT 按本轮实现同步:总体架构、模块设计、接口契约、数据模型、功能规格、文件设计与决策记录。
- 接口契约生成物重新导出(openapi 与前端客户端随契约一致)。
- 实现回顾与专项检查台账保留历史结论;本轮收尾发现另见 .agents.local 下的收尾报告与审查处置。
2026-09-18 01:15:18 +08:00

193 lines
8.7 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 后端-B01-作品规划:文件合同
本页从[目标文件清单](../目标文件清单.json)投影,共 15 个目标条目。测试身份与行为合同在现行用例清单;文件和目标合同不代表实现或验收已完成。
[返回目录](目录.md) · [完整项目树](../项目目录与文件职责.md) · [现行用例清单](../../../../tests/用例清单.json)
## 本部分文件树
```text
agent-example/
└── src/
└── muse/
└── 作品规划/
├── __init__.py # Python 包身份
├── 作品档案.py # 作品、系列、定位、目标与计划
├── 分层规划.py # 全书、卷、章、场景和节奏安排
├── 存储.py # 作品规划所属记录的 SQL 与版本读写
├── 探索交接.py # 最终格式检查与正式规划候选
├── 探索草稿.py # 受控私人稿件身份、原子保存和内容哈希
├── 接口.py # 作品规划公开用例和可导入合同
├── 提示词/
│ ├── 生成作品规划.md # 书级规划任务模板
│ └── 细化章节计划.md # 章级细纲任务模板
├── 模型.py # 作品规划稳定对象、外壳及内部状态
├── 模型规划.py # 准备规划模型投影与输出合同,写入带真实模型来源的 Shadow 候选
├── 目录调整.py # 稳定章节身份、重排、节点视图与影响
├── 规划版本.py # 规划候选、确认、分支及合并
├── 近期细化.py # 近期章节计划与可写条件
└── 进度查询.py # 正文、任务和决策的真实进度查询
```
## 逐文件合同
<a id="file-af200b34bbd352ed"></a>
### `src/muse/作品规划/接口.py`
- 归属与种类:B01;源码。
- 意图:让调用方通过稳定用例操作作品规划,隐藏模块内部组织。
- 职责:作品规划公开用例和可导入合同。
- 边界:唯一跨模块表面;导出输入输出合同,不暴露私有 SQL 或任意处理器。
- 目标:HTTP、CLI 和编排对相同用例得到一致验证、失败与结果。
- 合同依据:业务公开接口。
<a id="file-7477466ddaa96616"></a>
### `src/muse/作品规划/模型.py`
- 归属与种类:B01;源码。
- 意图:把作品规划的稳定数据骨架与执行实现分开。
- 职责:作品规划稳定对象、外壳及内部状态。
- 边界:纯模型和状态合同;不联网或写库,不把题材属性写死为类字段。
- 目标:稳定外壳可校验,动态内容携带结构绑定并在所属校验链验证。
- 合同依据:稳定模型。
<a id="file-d171df391bfe2870"></a>
### `src/muse/作品规划/存储.py`
- 归属与种类:B01;源码。
- 意图:将作品规划的数据访问与版本写入局限在本模块。
- 职责:作品规划所属记录的 SQL 与版本读写。
- 边界:只操作本模块记录并使用调用方事务;不跨 owner 写表或调用模型。
- 目标:版本读写及回滚可验证,不产生第二个独立事务结果。
- 合同依据:模块存储。
<a id="file-a79399b290b2858c"></a>
### `src/muse/作品规划/作品档案.py`
- 归属与种类:B01;源码。
- 意图:建立作品与系列的稳定身份,让目录、进度和创作目标有共同归属。
- 职责:作品、系列、定位、目标与计划。
- 边界:只管理档案与作者目标;不生成正文,不确认故事事实。
- 目标:新作品可以建立并关联规划、章节和任务,不需要写作品号分支。
- 合同依据:专属业务职责。
<a id="file-76a459a05ebb53b5"></a>
### `src/muse/作品规划/探索草稿.py`
- 归属与种类:B01;源码。
- 意图:允许作者在正式建模前保留不完整想法与分歧。
- 职责:受控私人稿件身份、原子保存和内容哈希。
- 边界:只经受控草稿接口保存私人内容;不写正式规划与上下文。
- 目标:草稿可往返保存并检测内容漂移,未交接内容不进入正文生成。
- 合同依据:专属业务职责。
<a id="file-9e62a75bf40f6b5f"></a>
### `src/muse/作品规划/探索交接.py`
- 归属与种类:B01;源码。
- 意图:把私人探索与正式规划之间的交接变成可检查动作。
- 职责:最终格式检查与正式规划候选。
- 边界:只检最终交付格式并形成规划候选;不把探索子阶段变成硬编码流程。
- 目标:局部探索可保留未知项,正式交接有来源和明确作者选择。
- 合同依据:专属业务职责。
<a id="file-b2a01b7f5ac6b1d2"></a>
### `src/muse/作品规划/分层规划.py`
- 归属与种类:B01;源码。
- 意图:把全书、卷、章和场景的计划组织为同一结构。
- 职责:全书、卷、章、场景和节奏安排。
- 边界:只修改规划;不把未来安排作为已发生事实,不直接改正文。
- 目标:各层计划能定位所属对象,修订保留版本和下游影响。
- 合同依据:专属业务职责。
<a id="file-8d1619fa73487275"></a>
### `src/muse/作品规划/近期细化.py`
- 归属与种类:B01;源码。
- 意图:按当前进展细化可执行章节,减少反复重做全书规划。
- 职责:近期章节计划与可写条件。
- 边界:只使用已允许的事实、方法和规划版本;不预读目标章答案。
- 目标:前置齐备才产生细纲候选,来源变化时旧细纲不直接复用。
- 合同依据:专属业务职责。
<a id="file-928d10ea81fe22a7"></a>
### `src/muse/作品规划/目录调整.py`
- 归属与种类:B01;源码。
- 意图:让作者重排章节时保持引用连续。
- 职责:稳定章节身份、重排、节点视图与影响。
- 边界:改变顺序而非身份;不能顺带改正文或忽略时点影响。
- 目标:重排后章节 ID 不变,受影响事实、上下文和后续计划可查。
- 合同依据:专属业务职责。
<a id="file-440c5b0183427b8d"></a>
### `src/muse/作品规划/规划版本.py`
- 归属与种类:B01;源码。
- 意图:保护作者确认过的规划与分支选择。
- 职责:规划候选、确认、分支及合并。
- 边界:本模块准备规划变更;正式提交经 S01,不绕过结构和审阅校验。
- 目标:旧版本不能覆盖当前规划,合并必须重新检查当前依赖。
- 合同依据:专属业务职责。
<a id="file-7e4742197701e907"></a>
### `src/muse/作品规划/进度查询.py`
- 归属与种类:B01;源码。
- 意图:用实际保存和任务状态呈现创作进展。
- 职责:正文、任务和决策的真实进度查询。
- 边界:只读并注明读取版本;不把缺失结果当完成,不维护第二份进度值。
- 目标:作者看到的进度能回查对应正文、任务和决定。
- 合同依据:专属业务职责。
<a id="file-4bdc85f5a92743d4"></a>
### `src/muse/作品规划/提示词/生成作品规划.md`
- 归属与种类:B01;源码。
- 意图:为作品规划的“生成作品规划”任务提供可版本化表达。
- 职责:书级规划任务模板。
- 边界:仅定义本任务提示;角色身份、字段结构、权限和预算从各自权威装配。
- 目标:模板可随发布包加载且记录哈希,不含固定作品内容或测试答案。
- 合同依据:业务提示资源。
<a id="file-a396acc5a7bfa53a"></a>
### `src/muse/作品规划/提示词/细化章节计划.md`
- 归属与种类:B01;源码。
- 意图:为作品规划的“章级细纲”任务提供可版本化表达;沿用文件名 `细化章节计划.md`,发布资源身份为 `规划/细化章节计划.md`。
- 职责:章级细纲任务模板。
- 边界:仅定义本任务提示;角色身份、字段结构、权限和预算从各自权威装配。
- 目标:模板可随发布包加载且记录哈希,不含固定作品内容或测试答案。
- 合同依据:业务提示资源。
<a id="file-400389dd774ea864"></a>
### `src/muse/作品规划/__init__.py`
- 归属与种类:工程;源码。
- 意图:明确安装包和模块的导入身份。
- 职责:Python 包身份。
- 边界:只声明包及必要公开导出;不读取运行数据、连接网络或启动任务。
- 目标:正常安装后可从任意 cwd 导入,导入无运行副作用。
- 合同依据:Python 包身份。
<a id="file-2533c0007a1651eb"></a>
### `src/muse/作品规划/模型规划.py`
职责:准备规划模型投影与输出合同,写入带真实模型来源的 Shadow 候选。
合同依据:专属业务职责。机械范围与用例绑定见[目标文件清单](../目标文件清单.json)中同路径条目。