Skip to content

LiorCohen/sdd / plugin/core/skills/spec-writing

spec-writing

Verified

Templates and validation for writing product specifications.

Spec Writing Skill

Templates

Use templates below as starting points.

Input

Schema: schemas/input.schema.json

Accepts spec type, change type, title, domain, and optional issue reference.

Output

Schema: schemas/output.schema.json

Returns complete SPEC.md markdown and validation results for required fields, sections, and format.

Spec Types: Product vs Tech

Product Specs (external input):

  • Focus on WHAT and WHY
  • Typically authored by product managers or stakeholders
  • Archived as-is when imported via external spec workflow
  • spec_type: product

Tech Specs (generated SPEC.md files):

  • Focus on HOW
  • Generated from product specs + solicitation
  • Full implementation details
  • spec_type: tech

Spec Lifecycle

Git is the state machine:

  • In PR = draft (implicit, no status field needed)
  • Merged to main = active
  • Explicit statuses only for: active, deprecated, superseded, archived

Spec Locations

TypeLocation
Change specschanges/YYYY/MM/DD/<change-name>/SPEC.md
Implementation planschanges/YYYY/MM/DD/<change-name>/PLAN.md
Domain definitionsspecs/domain/definitions/<definition-name>.md
API contractsspecs/architecture/api-contracts.md

Date-based organization:

  • Changes are organized by creation date (YYYY/MM/DD)
  • This provides chronological traceability
  • Plans live alongside their specs in the same directory

Acceptance Criteria Format

Always use Given/When/Then:

- [ ] **AC1:** Given [precondition], when [action], then [expected result]

Resource Files

For detailed guidance, read these on-demand:

slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack."Stars: 197kUpdated Claude CodeCodexVerifiedInstall
ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read.Stars: 194kUpdated Claude CodeCodexVerifiedInstall
ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report.Stars: 194kUpdated Claude CodeCodexVerifiedInstall
ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt.Stars: 194kUpdated Claude CodeCodexVerifiedInstall