返回顶部
s

spec-coderspec编码器

>-

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

spec-coder

规范编码工作流程

先编写规范,再生成代码。共5个阶段,每个阶段产出供下一阶段使用的工件。阶段间的专家评审关卡可及早发现问题。

会话开始

每次新会话:

  1. 1. 读取 specs/status.md 以识别当前阶段、活跃变更和延迟项。
  2. 读取阶段相关的规范文件 — 参见下方快速参考表,了解每个阶段产出/消费哪些工件。跳过 specs/changes/archive/ — 归档的变更是已完成/合并的工作,不得读取或引用。
  3. 与用户确认从哪个阶段/关卡继续。如果处于阶段中间,总结当前进展。
  4. 没有 specs/status.md? 这是一个新项目 — 从阶段0(现有代码库)或阶段1(全新项目)开始。

工作流程概览

阶段0 ──→ 阶段1 ──→ ║关卡1║ ──→ 阶段2a ──→ 阶段2b ──→ ║关卡2║
(扫描) (澄清) (需求) (设计) (预览) (设计)

┌────────────────────────────────────────────────────────────────┘

阶段2c ──→ 阶段2d ──→ ║关卡3║ ──→ 阶段3 ──→ ║关卡4║ ──→ 阶段4 ──→ 阶段5
(任务) (规范) (计划) (代码) (代码) (验证) (迭代)

┌─────────────┘

根据变更范围
重新触发关卡
2 / 3 / 4

当没有严重/主要问题时,关卡自动批准。详见专家评审协议

快速参考

阶段输入输出关卡下一步
0. 代码库扫描代码库文件status.md § 代码库上下文阶段1
1. 澄清与范围
用户需求 + 阶段0上下文 | requirements.md | 关卡1(需求) | 阶段2a | | 2a. 技术设计 | requirements.md | design.md | — | 阶段2b | | 2b. 设计预览 | design.md | design-preview/ | 关卡2(设计) | 阶段2c | | 2c. 任务分解 | design.md + requirements.md | tasks.md | — | 阶段2d | | 2d. 功能规范 | tasks.md + design.md | spec_xxx.md | 关卡3(计划) | 阶段3 | | 3. 生成 | tasks.md + spec_xxx.md | 代码 + 测试 | 关卡4(代码) | 阶段4 | | 4. 验证 | 代码 + 测试 + spec_xxx.md | 测试结果,实现映射 | — | 阶段5或完成 | | 5. 演进 | 主干规范 + 用户请求 | changes/ | 限定范围关卡 | → 阶段1–4 |

何时使用

触发条件:

  • - 用户提到规范编码、规范优先、规范驱动开发
  • 用户要求在实现前编写规范/需求/设计文档
  • 用户提到阶段关键词:澄清需求、编写规范、根据规范生成

何时不使用: 纯错误修复、单行配置变更、依赖更新,或无需设计决策、15分钟内可完成的任务。

复杂度分类 — 选择合适的路径:

路径适用场景阶段工件评审深度
小型单个端点、字段添加、< 1小时规范(精简)→ 生成 → 验证仅 specxxx.md精简(1–2个角色,琐碎情况跳过)
中型
单个功能、1–4小时、1–3个模块 | 澄清(简要)→ 规范 → 生成 → 验证 | specxxx.md + tasks.md | 标准(2–3个角色) |
| 大型 | 多模块、> 4小时、或新系统 | 完整5阶段工作流程 | 所有规范文件 | 完整(所有角色) |

询问用户适合哪条路径,或根据其请求范围推断。

小型路径快捷方式:
跳过阶段1。直接编写单个 spec_xxx.md(仅接口 + 业务规则 + 测试点),然后直接进入生成 → 验证。

中型路径快捷方式:
阶段1为简要的要点确认(无需完整的 requirements.md)。阶段2仅产出 tasks.md + spec_xxx.md(除非需要架构决策,否则跳过 design.md 和 design-preview/)。

项目中期进入:
如果用户已有规范文件或现有代码库,先读取它们。验证现有工件是否符合预期格式,然后确认从哪个阶段开始。

文件组织

两层结构:主干(当前系统真实状态)+ 变更(增量工作)。

specs/
├── index.md ← 导航中心:所有功能及近期变更
├── requirements.md ← 项目级需求(增量增长)
├── design.md ← 系统级架构(增量增长)
├── design-preview/
├── tasks.md ← 仅活跃任务
├── status.md
├── specname>.md ← 功能规范(当前真实状态,每个功能一个)
└── changes/ ← 所有增量工作
├── FEAT-NNN-name/ ← 新功能(完整规范生命周期)
│ ├── spec.md
│ ├── design.md
│ ├── tasks.md
│ └── delta.md ← 主干合并说明
├── CHG-NNN-name/ ← 变更/增强(仅增量)
│ ├── spec.md ← 已添加 / 已修改 / 已移除 部分
│ ├── tasks.md
│ └── delta.md
└── archive/ ← 已完成并合并的变更

首次项目: 仅从主干开始(不需要 changes/)。当第一个v1之后的功能或修改开始时,引入变更层。

有关完整生命周期管理详情,请参见规范生命周期管理

阶段0(可选):代码库扫描

对于现有代码库,在阶段1之前运行:读取依赖文件以检测技术栈,列出目录树,识别现有接口/模型/约定,并总结发现。

输出: 将结果写入 specs/status.md 的 ## 代码库上下文 部分(技术栈、关键约定、现有接口、目录结构摘要)。这将跨会话持久化扫描结果。阶段1引用此信息进行需求范围界定;阶段2a引用此信息进行架构决策。

阶段1:澄清与范围

目标: 将非正式需求转化为已确认的结构化 requirements.md。

约束: 不编写任何代码。仅提问和产出文档。

  1. 1. 交互式澄清 — 向用户询问原始需求。总结目标(3–5个要点),列出带有选项的歧义点,建议未考虑的约束。迭代直至确认。
  2. 结构化需求 — 产出 specs/requirements.md(参见模板):背景与目标、用户角色与用例、功能需求(FR-001...)、非功能需求、范围外。如果阶段0已运行,使用 status.md § 代码库上下文中与需求相关的上下文填充现有架构部分。

→ 关卡1:需求评审

根据专家评审协议 — 关卡1退出条件: 用户批准(或自动批准)。

阶段2:规范

目标: 产出直接驱动代码生成的规范文档。

2a:技术设计 → specs/design.md

基于 requirements.md,产出 specs/design.md(参见模板):

  1. 1. 架构概览(技术栈、层、服务)
  2. 核心模块分解,包含职责和依赖方向
  3. 关键数据模型、接口和交互流程
  4. 横切关注点(错误处理、认证、可观测性、部署)— 小型路径跳过
  5. NFR满足矩阵 + 关键架构决策(ADR格式)— 小型/中型路径跳过

对于现有代码库:使用 status.md § 代码库上下文中与架构相关的上下文(新增 vs. 修改)

标签

skill ai

通过对话安装

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

OpenClaw WorkBuddy QClaw Kimi Claude

方式一:安装 SkillHub 和技能

帮我安装 SkillHub 和 spec-coder-1776157142 技能

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

设置 SkillHub 为我的优先技能安装源,然后帮我安装 spec-coder-1776157142 技能

通过命令行安装

skillhub install spec-coder-1776157142

下载

⬇ 下载 spec-coder v0.1.4(免费)

文件大小: 25.86 KB | 发布时间: 2026-4-17 16:13

v0.1.4 最新 2026-4-17 16:13
spec-coder 1.0.0

- Clarified file reading rules: explicitly skip `specs/changes/archive/` (ignore archived/merged changes).
- All workflows and usage instructions unchanged except for archive exclusion.
- No file changes or functionality updates outside documentation clarification.

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

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

p2p_official_large
返回顶部