spec

Generates dependency-ordered specification sets with PRD, component designs, roadmap, and implementation plan.

37|17|Updated May 4, 2025
One-click install
npx skills add https://github.com/milvus-io/milvus-workshop --skill spec-milvus-io
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: spec
Source: https://github.com/milvus-io/milvus-workshop/tree/main/agent/.agents/skills/spec
Command: npx skills add https://github.com/milvus-io/milvus-workshop --skill spec-milvus-io

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Turning a rough feature idea into code without a written design leads to drift, missing invariants, and unbounded scope. This Skill converts requirements into a numbered, cross-linked, dependency-ordered spec set under ./specs that serves as the contract between intent and code. ## Core Features & Use Cases - Structured spec generation: Produces a PRD, data model, per-component designs, cross-cutting specs (security, performance, testing), glossary, and a key-decisions log, sized to the complexity of the system. - Dual planning documents: Writes a stakeholder-facing milestone roadmap (90-roadmap.md) and an engineer-facing dependency-ordered implementation plan (91-impl-plan.md) that pair 1:1 but are organized differently. - Prior-art grounding: Cross-references research memos in ./docs/research, vendored code in ./vendors, and encodes AGENTS.md engineering norms directly into design decisions. - Use Case: A team wants to build an observability SDK. The Skill produces an index, PRD with measurable goals, component designs with ASCII architecture diagrams, a phased roadmap with exit criteria, and a key-decisions log before any code is written. ## Quick Start Use the spec skill to turn my feature idea into a dependency-ordered spec set with a PRD, roadmap, and implementation plan under ./specs.

Frequently Asked Questions about spec

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

FAQPage Schema
How do I write a software design spec before coding?

Describe your feature idea or requirement and ask for a spec set. The Skill captures intent, reviews existing research and vendored code, then writes a PRD, data model, component designs in build order, a roadmap, and an implementation plan under ./specs.

What is the difference between a roadmap and an implementation plan?

The roadmap (90-roadmap.md) is organized by user-visible milestones with exit criteria for stakeholders. The implementation plan (91-impl-plan.md) is organized by dependency order with phased tasks and effort estimates for engineers. They pair 1:1 but use different ordering.

How many spec files should a project have?

The number depends on system complexity, not a fixed template. A small library may need only a PRD, one design doc, and a roadmap, while a large platform may need 15 or more files covering cross-cuts like security, performance, and testing.

Does the spec skill work with existing research or design docs?

Yes. Before writing, it reads ./specs/index.md, all memos in ./docs/research, vendored code in ./vendors, and AGENTS.md engineering norms, citing their decisions rather than re-litigating them.

When should I not use a full spec set?

Skip it for trivial changes or single-purpose utilities where ad-hoc coding carries no risk of drift or missing invariants. The Skill itself right-sizes output, producing as few as three files for small systems.