Files
CraftKit/plugins/dev/skills/design-backend/SKILL.md
T

2.6 KiB

name, description
name description
design-backend 基于需求、现有后端代码和项目规范设计模块边界、服务职责、数据影响、事务、错误处理和接口需求。适用于新功能或复杂后端变更的技术设计;直接编码、单纯数据库建模、HTTP 契约细化或前端设计不应触发。

后端设计

形成可由实现人员执行和验证的后端设计,不生成业务代码,不内置特定 Java、Spring 或公司框架规则。

工作流

  1. 读取需求、项目元数据、适用规范、依赖清单和相关后端实现,确认语言、框架及精确版本。
  2. 按 Profile 消费规则 确定目标模块和 backend-design 能力;提供方缺失时继续使用中性流程并报告缺口。
  3. 按 范围分析 明确现状、边界、参与者和约束。
  4. 设计模块职责、调用关系、数据所有权、事务边界、并发策略、错误语义、权限和可观测性。
  5. 数据库或 HTTP 契约需要详细设计时,记录输入和待决项,交由相应专项 Skill;本 Skill 保持整体一致性。
  6. 按 设计输出 展示方案、备选项和风险,并用 评审清单 自检。
  7. 默认在对话中输出;用户要求落盘时读取 .craftkit/project.json 的 documents 配置,过程设计使用 workRoot,共享设计使用 designRoot,并保守写入。

落盘前检索同主题的需求、设计、规范或知识,优先更新已有权威文档。共享长期文档新建或实质修改后按 .craftkit/standards/document-maintenance.md 更新审核状态;排版和错字修正不改变状态。

写入后在 workRoot/<task>/task.json 登记本次创建、更新或引用的文档及 relationship;已有记录时保守合并。关联旧文档不转移所有权,也不产生删除权限;不修改项目级默认配置。

边界

  • 已安装 guidance 时用它获取项目规则;未安装时按“目标目录适用的 AGENTS.md → .craftkit/agents/index.md → .craftkit/standards/index.md → 命中正文”的顺序手工读取。不存在的规范、框架能力和依赖接口不得猜测。
  • 版本从 .craftkit/project.json、构建文件、锁文件或源码证据确认,不默认最新版本。
  • 当前会话没有发现语言提供方时,不扫描插件缓存或猜测物理路径。
  • 对现有系统的设计先追踪真实调用链和数据流,区分已验证事实与建议。
  • 不把接口示例、表结构草案或伪代码视为已实施行为。