om-spec-writing

Write and review feature specifications with skeleton-first drafting and severity-ranked architectural review.

2.6k|159|Updated Mar 8, 2021
One-click install
npx skills add https://github.com/go-musicfox/go-musicfox --skill om-spec-writing-go-musicfox
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: om-spec-writing
Source: https://github.com/go-musicfox/go-musicfox/tree/main/.agents/skills/om-spec-writing
Command: npx skills add https://github.com/go-musicfox/go-musicfox --skill om-spec-writing-go-musicfox

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Writing feature specifications that are architecturally sound, properly scoped, and ready for implementation is hard; this Skill enforces a staff-engineer-grade process with a hard Open Questions gate so specs never proceed on unexamined assumptions. ## Core Features & Use Cases - Skeleton-first drafting: Start with a TLDR plus key sections and a numbered Open Questions block that acts as a hard stop before research or design begins. - Structured spec output: Produces a standardized spec covering problem statement, architecture, data model, API contracts, edge cases, risks, and a phased implementation plan where every step leaves the app working. - Severity-ranked architectural review: Audits existing specs with findings ranked Critical/High/Medium/Low against the repository's own agent instructions and canonical primitives. - Autonomous mode: An --autonomous flag resolves gate questions with the most reversible, lowest-blast-radius defaults for unattended pipeline runs. - Use Case: A developer needs a spec for a new caching layer; the Skill drafts a skeleton, blocks on critical unknowns like cache invalidation strategy, then produces a phased plan that maps directly onto an automated PR-creation workflow. ## Quick Start Ask the agent to write a spec for your feature idea, providing a short brief describing what you want to build.

Frequently Asked Questions about om-spec-writing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a feature specification with an AI agent?

Provide a brief describing the feature, and the Skill drafts a skeleton spec with a TLDR and key sections first. It then blocks on numbered Open Questions about critical unknowns before proceeding to research, design, and a phased implementation plan.

How do I review a spec for architectural problems?

Ask for an architectural review of the spec file. The Skill produces findings ranked Critical, High, Medium, and Low, checking scope cohesion, canonical primitives, contract compatibility, reversibility, coupling, sensitive data handling, and failure scenarios.

What sections does a generated specification contain?

Specs include TLDR, Problem Statement, Proposed Solution, Architecture, Data Model, API Contracts, UI/UX, Edge Cases and Failure Scenarios, Risks and Impact Review, Phasing, and an Implementation Plan with testable steps that each leave the app working.

Can the spec writing process run without human interaction?

Yes, the --autonomous flag resolves Open Questions itself using the most reversible, lowest-blast-radius defaults, marking risky choices as needing human confirmation. Interactive mode remains the default, where the Open Questions gate is a hard stop.

Where are generated spec files stored?

Specs are saved as dated kebab-case markdown files in the directory resolved from the agentic config's paths.specs value, defaulting to .ai/specs. Without config, it falls back to existing design-doc directories like docs/specs or rfcs.

When should a feature be split into multiple specs?

Split when a brief bundles more than one independently deployable capability, tested by asking whether each part would function without the other. The Skill raises this as a mandatory Open Question during skeleton drafting.