Files
persionalBrand/docs/adr/0014-template-admin-content-contract.md
T

2.2 KiB
Raw Blame History

0014 模板声明品牌内容编辑契约

Context

平台需要支持大量视觉与交互差异明显的小程序模板。品牌管理员需要配置自己的介绍、案例、图片和咨询内容,但不应理解 renderer、JSON、schema 或模板内部实现。当前 Admin 使用一套硬编码的页面表达字段,无法可靠覆盖阿成校园餐与林境建筑画册的不同业务表达。

Decision

每个视觉模板 package 的 template.json 声明:

  • dataSlots:运行时和发布检查需要的稳定业务数据集合;
  • assetSlots:图片和媒体的业务名称、用途、必填性与推荐比例;
  • admin.sections:品牌管理员看到的编辑分组、字段文案、帮助、输入类型与内部绑定。
  • sampleContent:安装模板时可选择导入的品牌示例业务内容,包括提供项、信任内容和咨询字段。

模板 package 是页面结构、视觉、交互和内容编辑说明的唯一来源。后端负责校验、品牌隔离、快照与稳定数据投影;Admin 读取声明并渲染业务化表单。binding、renderer、capability、schema 等技术信息不会展示给品牌管理员。

Alternatives

  • 继续在 Admin 写共享页面表达字段:不能覆盖行业与视觉差异,模板增多后会产生模板 key 分支。
  • 让品牌管理员编辑 JSON:灵活但不可用,且容易破坏发布内容。
  • 用公共视觉积木约束所有模板:会牺牲模板的页面与交互自由度。

Consequences

  • 新模板必须同时交付页面代码、内容契约、媒体要求和业务化编辑文案。
  • RuntimeWorkspace、发布检查和 Admin 需要在后续任务消费同一契约。
  • 包内 manifest 的版本变更将进入发布快照,保证已发布品牌的展示可追溯。
  • 模板示例内容随 package 版本管理,不进入后端 seed.ts;导入后复制为品牌自己的草稿数据。

Migration Plan

  1. 为阿成与林境补齐内容契约。
  2. 将契约投影到 RuntimeWorkspace 和发布快照。
  3. 发布前按必填槽位输出可行动提示。
  4. 用声明驱动品牌管理员工作台,移除硬编码的通用页面表达表单。
  5. 将模板示例内容迁移到 package manifest,seed 仅保留开发环境基础品牌 fixture。