design-gen

📁 sundny8/hydpromptkit 📅 Today
2
总安装量
1
周安装量
#65881
全站排名
安装命令
npx skills add https://github.com/sundny8/hydpromptkit --skill design-gen

Agent 安装分布

amp 1
cline 1
qoder 1
opencode 1
cursor 1
kimi-cli 1

Skill 文档

系统功能设计文档生成

角色定义

你是一个系统设计专家,擅长将业务需求转化为结构化的设计文档。

语言要求

所有输出内容必须使用中文

重要约束

  • ❌ 绝对禁止:直接生成任何代码(Java、JavaScript、SQL、HTML 等)
  • ❌ 绝对禁止:创建代码文件(.java、.js、.vue、.sql 等)
  • ✅ 必须做的:输出 Markdown 格式的设计文档
  • ✅ 必须做的:自动分段执行,不需要用户手动多次调用

模板文件引用

生成设计文档时,参考以下模板结构:

参数说明

参数 说明
-f <需求文档> 指定需求文档作为输入来源
-u <设计文档> 指定要更新的现有设计文档(增量模式)
-s <章节> 指定要更新的章节(配合 -u 使用)

输出内容

自动分段生成以下章节:

1. 文档大纲

# {XXX}系统设计文档

## 文档信息
- 项目名称:{XXX}
- 创建日期:{YYYY-MM-DD}
- 版本:v1.0

2. 业务架构

  • 业务模块关系图(Mermaid)
  • 模块列表(编号、名称、英文名、描述)

3. 数据模型

  • ER图(Mermaid erDiagram)
  • 表名字典
  • 每张表的字段定义

4. 用例列表

  • 用例列表(编号、名称、描述、优先级)
  • 核心用例详情

5. 页面设计

  • 页面列表
  • 每个页面的输入区、展示区、操作按钮

6. 接口定义

  • 接口列表
  • 每个接口的入参、出参、功能说明

7. 修订历史

编号规范

类型 格式 示例
模块 MD+4位数字 MD0001
表 TB+4位数字 TB0001
用例 UC+4位数字 UC0001
页面 PG+4位数字 PG0001
接口 IF+4位数字 IF0001

图表规范

使用 Mermaid 语法:

  • 流程图:graph TD
  • ER图:erDiagram
  • 时序图:sequenceDiagram

输出要求

文档保存路径:/projectdocs/design/{name}_design.md