SuperAPI AI 工具集

umbraco-content-requirements-documentation

编程与开发

查看项目

更新于 10-22 05:17

技能介绍

用途

这个技能用于规范 Umbraco 17+ 站点上的 Schema(内容模型)变更流程:变更不直接动手,而是先写成 Markdown 需求文档,经审批后再执行,执行后读回验证。核心口号是“先写需求、停下等审批、再应用、再验证”;状态仍为 proposed(提案)的需求文档绝不能用于创建或修改站点 Schema。

主要能力

  • 六步变更流程:1)检查现有 Schema,使需求文档贴合现状;2)按模板为每个制品写一页文档,并附变更集;3)反复运行 lint 直到无错误;4)暂停,等待用户审批变更集;5)通过 MCP 或手动步骤应用;6)读回每个制品,与需求文档比对并更新状态行。
  • 双执行机制:优先使用 Umbraco Developer MCP 的工具;若 MCP 未连接或站点未运行,则基于同一份需求文档生成手动操作指引,不放弃文档、不另辟路径。不涉及 uSync、Deploy 或 package.xml 输出。
  • 每次通过 MCP 创建制品后都要做一次修补:创建工具无法设置排序、必填、属性描述、模板或区域性变体。
  • 一个变更集对应一句用户能描述清楚的变更,其勾选清单让中断后的应用可以续做。
  • 已存在的内容通过引用,不重复描述;需求页仅针对本次新建或修改的对象。
  • 用脚本而非目视检查:node scripts/lint-requirements.mjs <requirements-root>,与 CI 使用同一套确定性检查。

使用方式

  • 依赖配套技能 umbraco-content-model-conventions 来定义命名、文件夹、选项卡、排序等规则,必须同时安装;若该链接无法读取,应停止并说明,不能凭记忆操作。
  • 按 change-workflow.md 的六步执行,各步细节见 inspect-existing-schema.md、requirements-format.md、requirements-lifecycle.md、apply-via-mcp.md、apply-manually.md、verify.md。
  • 模板位于 assets/ 目录,为 Markdown 文件而非代码。

适用场景

需要对 Umbraco 17+ 站点做可审计、可审批、可回读的内容模型(Schema)变更,并希望在 MCP 不可用时仍能以手动方式落实同一份需求文档的团队。

限制

  • 目标版本为 Umbraco 17+;MCP 工具名与行为基于 @umbraco-cms/mcp-dev 17.6.8(运行于 Umbraco 17.5.3)并与 18.1.7 包源码核对,工具名可能随版本漂移,应以已连接工具列表为准。
  • 状态行 applied 只能在制品读回后或用户确认已完成手动步骤后写入。
  • 验证断言位于 evals/evals.json,需用 umbraco-skill-evaluator 运行;覆盖层级为 Documented。需求文档格式由 lint 脚本强制校验,CI 对 golden-requirements/ 必须通过、对 broken-requirements/ 必须失败。