ghwf2-spec_skill

This skill helps you generate a comprehensive specification document from GitHub issues and kickoff notes, automating structure and templates.

Shell

0

GitHub Stars

1

Bundled Files

2 months ago

Catalog Refreshed

4 months ago

First Indexed

Readme & install

Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.

Installation

Preview and clipboard use veilstrat where the catalogue uses aiagentskills.

npx veilstrat add skill shotaiuchi/dotclaude --skill ghwf2-spec

SKILL.md1.7 KB

Overview

This skill automates creation and revision of a formal specification document (02_SPEC.md) from a GitHub Issue and kickoff document. It reads project context, merges issue comments as requirements, writes the spec using a template, commits the file, updates the PR checklist and issue labels, and advances workflow state. It supports interactive updates and revision flows triggered by feedback.

How this skill works

The skill loads active work context from state.json and the existing 01_KICKOFF.md, then fetches the target GitHub Issue body and comments to capture requirements. It fills a predefined template (~/.claude/templates/02_SPEC.md) with Functional and Non-functional Requirements, Data Model, API/Interface Design, and Edge Cases. Finally it commits and pushes the new spec, updates the pull request checklist, adjusts issue labels, and writes the next workflow state.

When to use it

After completing kickoff (ghwf1-kickoff) and confirming 01_KICKOFF.md is present
When an Issue contains requirements and discussion that must be formalized into a spec
When you need a reproducible, committed spec file in docs/wf/<work-id>/02_SPEC.md
When feedback arrives and the spec must be revised and versioned

Best practices

Ensure 01_KICKOFF.md and state.json are up to date before running
Keep issue comments focused; the skill treats comments as additional requirements
Review generated Functional and Non-functional sections for domain nuance before wide distribution
Use the interactive update mode to refine scope before final commit
Append clear revision notes when incorporating feedback to preserve traceability

Example use cases

Convert a feature request Issue with stakeholder comments into a formal spec ready for planning
Generate an initial API design and data model from kickoff artifacts to hand to engineering
Apply reviewer feedback to an existing spec and publish a committed revision
Automate checklist progression and labeling so the next workflow step (ghwf3-plan) is unblocked

FAQ

You must have completed ghwf1-kickoff and have 01_KICKOFF.md in the work directory; state.json must reflect the active work.

Does the skill require confirmation before pushing commits?

No. By design it stages, commits, and pushes the spec immediately to keep workflow automated.