返回顶部
t

technical-spec-design技术规格设计

>

作者: admin | 来源: ClawHub
源自
ClawHub
版本
V 1.0.1
安全检测
已通过
144
下载量
免费
免费
2
收藏
概述
安装方式
版本历史

technical-spec-design

安装

OpenClaw 设置(推荐)

OpenClaw 是该技能的主要平台。它使用基于工作区的提示注入,并支持自动技能加载。

通过 ClawdHub(推荐):
bash
clawdhub install technical-spec-design

手动安装:
bash
git clone https://github.com/wjszxli/technical-spec-design ~/.openclaw/skills/technical-spec-design

技术规格设计技能

1. 输入契约

接受以下输入类型:

  1. 1. 完整的 PRD 文档
  2. 简短的需求描述(可能不完整)
  3. 现有的技术规格(用于优化/评审)

2. 可用资源

核心模板

资源用途使用场景
spectemplate.md主规格模板开始新的技术规格
componenttemplate.md
组件设计 | 设计单个组件| | requirementsanalysis_template.md | 需求分析 | 拆解需求 |

示例

资源用途
examples/sampleinput.md示例 PRD 输入
examples/sampleoutput.md
完整规格示例 |

脚本

脚本用途使用方式
scripts/generatespec.py从模板生成规格python scripts/generatespec.py --interactive -o myspec.md
scripts/validate.py
验证技能结构 | python scripts/validate.py |

3. 输出契约

输出必须为 Markdown 格式,并严格包含以下结构(可根据模式裁剪):

标准结构

  1. 1. 需求澄清(如有需要)
  2. 需求分析(三要素)
  3. 技术规格设计
  4. 组件/模块设计
  5. 技术选型对比(如适用)
  6. 风险与边界分析
  7. 待定问题

4. 模式系统(自动选择)

模式 A:需求澄清模式

触发条件:
  • - 输入信息不足
  • 存在关键不确定性

输出:

  • - 仅输出“需求澄清问题”
  • 不进行任何设计工作



模式 B:轻量规格模式


触发条件:
  • - 简单功能
  • 实现路径相对清晰

输出:

  • - 简化的需求分析
  • 核心规格设计
  • 简要的组件拆解



模式 C:完整技术规格模式(默认)


触发条件:
  • - 中大型需求
  • 涉及架构/组件设计/技术选型

输出完整结构



5. 执行流程(必须严格遵循)

步骤 1:需求完整性检查

检查缺失信息:

  • - 用户目标
  • 需求背景
  • 输入与输出
  • 约束条件
  • 边界情况

如果缺失:
→ 进入模式 A,仅输出澄清问题



步骤 2:需求分析(三要素)

1. 功能拆解

格式: 产品需求 → 页面/模块 → 变更点

2. 用例分析

描述完整的用户路径(跨页面)

3. 页面操作规范

格式: 动作 + 条件 + 对象 + 行为

步骤 3:技术规格设计

包括:

  • - 架构拆解(前端/后端/服务)
  • 数据流设计
  • 状态管理
  • 核心流程(可使用伪代码)

步骤 4:组件/模块设计

要求:

  • - 必须细化到组件/模块级别
  • 明确的职责边界
  • 描述依赖关系

步骤 5:技术选型对比(如有多个选项)

必须使用表格格式:

| 方案 | 描述 | 优点 | 缺点 | 适用场景 |



步骤 6:风险与边界分析

必须包括:

  • - 边界情况
  • 性能问题
  • 可扩展性
  • 异常处理

步骤 7:输出待定问题

列出所有仍需产品/业务确认的问题



6. 输出约束(强制要求)

禁止

  • - ❌ 输出可运行代码(JS / TS / Java / SQL 等)
  • ❌ 跳过需求分析直接编写规格
  • ❌ 基于“常见情况”做假设
  • ❌ 使用模糊语言(如“可能”、“通常”)

必须

  • - ✅ 使用结构化表达
  • ✅ 使用伪代码描述流程
  • ✅ 所有变更必须映射到组件/模块
  • ✅ 明确的边界和异常情况

7. 技术调研指南

当存在多种方案时,必须使用对比表格——不允许纯文本描述。



8. 危险信号(必须停止)

如果出现以下任何想法,必须停止并返回流程:

  • - “先写个粗略的规格”
  • “按常规方式处理”
  • “边编码边设计”
  • “这个需求很简单,不需要分析”

9. 快速检查清单

输出前,必须确认:

  • - [ ] 需求已澄清
  • [ ] 三要素已完成
  • [ ] 组件设计已包含
  • [ ] 使用了伪代码
  • [ ] 边界情况已分析
  • [ ] 待定问题已记录

10. 示例(少样本)

示例 1:模糊需求(模式 A)

输入:
“构建一个评论功能”

输出:

  • - 评论是否支持回复?
  • 是否需要分页?
  • 是否需要点赞/顶?
  • 是否需要审核?



示例 2:简单需求(模式 B)

输入:
“表单提交后显示成功消息”

输出:

  • - 简要功能拆解
  • 状态转换
  • Toast/通知组件设计



示例 3:复杂需求(模式 C)

输入:
“设计一个具有多角色权限的管理系统”

输出:
完整的技术规格结构(包括技术对比)



核心原则(总结)

技术规格的本质:在编码之前消除不确定性。

标签

skill ai

通过对话安装

该技能支持在以下平台通过对话安装:

OpenClaw WorkBuddy QClaw Kimi Claude

方式一:安装 SkillHub 和技能

帮我安装 SkillHub 和 technical-spec-design-1776026844 技能

方式二:设置 SkillHub 为优先技能安装源

设置 SkillHub 为我的优先技能安装源,然后帮我安装 technical-spec-design-1776026844 技能

通过命令行安装

skillhub install technical-spec-design-1776026844

下载

⬇ 下载 technical-spec-design v1.0.1(免费)

文件大小: 17.1 KB | 发布时间: 2026-4-13 12:18

v1.0.1 最新 2026-4-13 12:18
No functional changes. Added installation instructions.

- Added a new "Installation" section explaining OpenClaw setup and installation commands.
- No changes to core logic, execution flow, input/output contracts, or templates.
- Audience now has clear guidance for installing and using the skill with OpenClaw.

Archiver·手机版·闲社网·闲社论坛·羊毛社区· 多链控股集团有限公司 · 苏ICP备2025199260号-1

Powered by Discuz! X5.0   © 2024-2025 闲社网·线报更新论坛·羊毛分享社区·http://xianshe.com

p2p_official_large
返回顶部