skill-write-hld

write-hld 技能:生成 HLD 详细设计文档;两种模式——总览(含设计风格/色调,供 CLD)/ 模块(每个业务模块一份,页面+流程,供 HFPD)。

2026年06月05日 1024 字 约 2 分钟阅读
skill-write-hld

description: 生成 HLD 详细设计文档(.md);两种模式 —— 总览(含设计风格/色调,供 CLD)/ 模块(页面+流程,供 HFPD)
argument-hint: [--module <模块名>] [--mvp]
allowed-tools: [Read, Write, AskUserQuestion]


用户输入:$ARGUMENTS

两种模式

模式 触发 输出 下游
总览 默认 A需求文档/[项目]_HLD_总览.md /write-cld
模块 --module <模块名> A需求文档/HLD_<模块名>.md /write-hfpd

关键:CLD 读总览取风格 / 色调;HFPD 读各模块 HLD 拼页面。


执行流程

1. 判定模式 & 读输入

  • --module → 模块模式
  • 否则 → 总览模式
  • 读 PRD(若给路径);模块模式额外读 [项目]_HLD_总览.md(不存在则提示先跑总览,不允许跳过)

2. 澄清(用 AskUserQuestion 一次问完)

总览模式问
1. 几个端?(单端 / B+C / P+T+C / 其他)
2. 是否多租户 SaaS?
3. 核心业务模块列表(若 PRD 没列)
4. 设计风格关键词(简洁 / 科技感 / 亲切 / 专业 / 极简…)

模块模式问
1. 该模块涉及哪几个端?
2. 模块入口(哪个菜单层级)?
3. 是否依赖其他模块的数据/接口?
4. 有无"列表+CRUD"之外的特殊页面(统计、看板等)?

3. 输出文档


总览模式骨架

# [项目] HLD 总览(v[N])

[文档头表格:版本 / 日期 / 状态 / 上游 PRD / 下游 CLD+模块 HLD]

## 1. 产品整体结构
- 1.1 端列表(端 / 简称 / 使用者 / 路径前缀)
- 1.2 模块总览(树形;每个模块标注对应的 HLD_<模块>.md)
- 1.3 模块依赖关系(Mermaid 或文字)

## 2. 全局交互规范
- 表单(必填位置 / 校验时机 / 错误样式)
- 操作反馈(Toast / 确认弹窗触发场景)
- 分页(每页数 / 位置 / 跳页)
- 空状态、加载状态

## 3. 设计风格与色调  ★ CLD 唯一输入源
- 3.1 风格关键词(3-5 个形容词)
- 3.2 主色板:primary / secondary / success / warning / danger / info(每个色值)
- 3.3 中性色:主要文字 / 次要文字 / 禁用 / 边框 / 背景 / 卡片
- 3.4 字体:H1 / H2 / 正文 / 辅助 / 按钮(字号·字重·行高)
- 3.5 圆角 / 阴影 / 间距(radius-sm/md/lg、shadow-sm/md、spacing-xs..xl)

## 4. 全局权限与角色(若 PRD 已定义则复述)

## 5. 模块 HLD 文件清单
| 模块 | HLD 文件 | skill 命令 |
| --- | --- | --- |

--mvp 差异:模块清单更简略;第 3 节风格更详细;可加"典型页面氛围"小节(登录/首页/列表大概长什么样)。


模块模式骨架

# HLD · [模块名]

[文档头:版本 / 上游需求 / 上游设计=HLD_总览 / 变更摘要]

## 一、需求摘要
- 用户原话 + 1-3 句提炼
- 各子功能 + 业务约束

## 二、设计目标与边界
- 目标 / 非目标(**【V2/V3】延后项必标**)/ 复用已有能力

## 三、页面清单
| 页面 | 路径 | 入口 | 主要操作 |

## 四、各页面详细设计(每页一节)
- 4.x.1 页面结构布局(顶/侧/内容/操作区怎么分)
- 4.x.2 关键字段/列(字段·类型·必填·备注)
- 4.x.3 业务工作流程(编号步骤)
- 4.x.4 异常流程(场景 → 处理)
- 4.x.5 权限(角色 → 可见/可操作)

## 五、模块整体业务流程(可选,跨页面 Mermaid)

## 六、依赖与兜底

4. 保存

  • 总览:document/A需求文档/[项目]_HLD_总览.md
  • 模块:document/A需求文档/HLD_<模块>.md

告知下一步:
- 总览 → /write-cld 生成组件库;按模块跑 /write-hld <需求> --module <模块名>
- 模块 → /write-hfpd <HLD总览> <CLD.pen> --module <模块名> 生成原型;/write-tad 加入该模块 HLD


约束

  1. 总览不写具体页面模块不重复总览(继承全局规范,不复述)
  2. 模块模式禁止跳过总览
  3. 【V2】【V3】延后项必须显式标注
  4. 不发明数据;不确定的字段留 【待补充】

评论区

暂无评论,来发表第一条吧!