Files
OpenSpec/docs/overview.md
T
Clay GoodandClaude Opus 5 b928165276 docs(explore): stop claiming explore never writes files (#1838)
* docs(explore): stop claiming explore never writes files

Sixteen lines across both documentation trees told users that
`/opsx:explore` creates no artifacts and writes no files, full stop.

That has been false since explore shipped (#467): its capture branch
writes the planning artifacts the user asked for, and can edit an
existing change's artifacts. #1503 later made it scaffold with
`openspec new change` first, closing #668 and #720.

The claim appeared in two shapes. Six lines denied the capability
outright ("Explore creates no artifacts and writes no code"). Ten more
said the same thing as a timing claim ("before any artifact exists"),
which reads as ordinary pitch copy and is what escaped the first pass.

Every site now carries one guarantee, worded the same way: explore
never writes code, and writes nothing else unless you ask, or say yes
when it offers. Four sites described only the user-initiated trigger,
which left the offer path - the one a reader actually hits - looking
like it did not exist.

docs/explore.md and docs/commands.md also gain a positive description
of capture where the denial used to sit, including what scaffolding
creates beyond the artifacts you named, and how capture differs from
handing off to propose (propose writes the set your schema requires;
capture writes only what you named).

Closes #1833

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(docs): keep the retired explore wording retired

A flat list of the phrasings that actually carried the claim, swept
over the eleven pages that pitch explore. Fails on main with all
sixteen offenders; clean on this branch.

Modeled on test/vocabulary-sweep.test.ts, and deliberately a list
rather than a grammar. An earlier draft built the grammar - section
splitting, code-fence tracking, a conditional-marker exemption so
"creates no artifacts unless you ask" would pass - and measured
against realistic prose it was imprecise in both directions while
returning the same verdict on the real input. The list has no
exemption logic to get wrong, and any maintainer can extend it.

Phrasings that are only wrong in the absolute ("writes nothing",
"creates nothing") are left to review, since the conditional form of
each is the wording the failure message recommends.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(docs): pin the explore capture contract, not the word

The guide check matched any "capture", so "explore automatically captures
every artifact" passed. Both explore.md and commands.md now must name the
user trigger, `openspec new change`, and the named-artifacts scope, with no
capture line claiming it happens unprompted, and keep "never writes code".

Also scope the explore.md guarantee to the setup files a new change needs,
and make the commands.md offer name the change and its scope, which the
template asks for on main and after #1832.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(docs): accept negated unprompted-capture wording, catch non-capture verbs

The unprompted check matched "automatically" on any capture line, so the
correct "Explore does not automatically capture artifacts" failed, while
"Explore automatically writes planning artifacts" was never scanned because
it lacks the word capture. Check each clause of lines naming explore or
capture for an unprompted write verb with no preceding negation.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 15:45:53 +00:00

7.3 KiB

Core Concepts at a Glance

OpenSpec is a lightweight agreement layer between you and your AI. You write down what a change should do, the AI drafts the details, you both look at the same plan, and only then does code get written. This page is the whole mental model on one screen. When you want the long version, Concepts has it.

Here's the entire idea in five words: agree first, then build confidently.

The five ideas

Everything in OpenSpec is built from five concepts. Learn these and the rest is detail.

1. Specs are the truth. A spec describes how your system behaves right now. It lives in openspec/specs/, organized by domain (auth/, payments/, ui/). Specs are made of requirements ("the system SHALL expire sessions after 30 minutes") and scenarios (concrete given/when/then examples). Think of specs as the single agreed-upon answer to "what does this software do?"

2. A change is one unit of work. When you want to add, modify, or remove behavior, you create a change: a folder in openspec/changes/ holding everything about that work in one place. A proposal, a design, a task list, and the spec edits. One change, one folder, one feature.

3. Delta specs describe what's changing, not the whole world. Inside a change, you don't rewrite the entire spec. You write a small delta: ADDED this requirement, MODIFIED that one, REMOVED this other one. This is the trick that makes OpenSpec good at editing existing systems, not just green-field ones. You describe the diff, not the destination.

4. Artifacts build on each other. A change contains a few documents, created in a natural order, each feeding the next:

proposal ──► specs ──► design ──► tasks ──► implement
   why        what       how       steps      do it

You can revisit any of them at any time. They're enablers, not gates. (More on that below.)

5. Archiving folds the change back into the truth. When the work is done, you archive the change. Its delta specs merge into your main specs, and the change folder moves to changes/archive/ with a date stamp. Now your specs describe the new reality, and you're ready for the next change. The cycle closes.

The picture

┌─────────────────────────────────────────────────────────────────┐
│                          openspec/                              │
│                                                                 │
│   ┌──────────────────┐         ┌──────────────────────────┐    │
│   │     specs/       │         │        changes/          │    │
│   │                  │ ◄─────  │                          │    │
│   │ source of truth  │  merge  │ one folder per change    │    │
│   │ how things work  │  on     │ proposal · design ·      │    │
│   │ today            │ archive │ tasks · delta specs      │    │
│   └──────────────────┘         └──────────────────────────┘    │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Two folders. specs/ is what's true. changes/ is what you're proposing. Archiving moves a proposal into truth.

The loop you'll actually run

In the default setup, your day looks like this. Optionally think it through first; then one command drafts the plan, you read it, the next builds it, and the last files it away.

/opsx:explore                   →  (optional) think it through with the AI first
/opsx:propose add-dark-mode     →  AI drafts proposal, specs, design, tasks
        (you read and adjust the plan)
/opsx:apply                     →  AI builds it, checking off tasks
/opsx:archive                   →  specs updated, change archived

When in doubt, start by exploring. /opsx:explore is a no-stakes thinking partner: it reads your code, lays out options, and turns a fuzzy idea into a concrete plan before any code gets written. It's the best antidote to an AI that will otherwise build something from a vague prompt. Already know exactly what you want? Skip straight to /opsx:propose. Either way, explore ships in the default profile, so it's always there. See the Explore guide.

Those are slash commands, typed in your AI assistant's chat. Setup (openspec init) happens in your terminal. If that split is new to you, read How Commands Work first; it's the most common point of confusion.

"Enablers, not gates"

This phrase shows up everywhere in OpenSpec, so here's what it means in plain terms.

Old-school spec processes are waterfalls: finish planning, then you're allowed to implement, and going back is painful. OpenSpec refuses that. The order proposal → specs → design → tasks shows what becomes possible next, not what you're forced to do next.

Discover during implementation that the design was wrong? Edit design.md and keep going. Realize the scope should shrink? Update the proposal. Nothing locks. The dependencies exist only so the AI has the context it needs (you can't write good tasks without specs to base them on), not to box you in.

The strength here is honesty: real work is messy and iterative, and OpenSpec lets it be. The tradeoff is discipline: because nothing forces you forward, it's on you to keep a change focused rather than letting it sprawl. The Workflows guide has good habits for that.

Why this is worth the small overhead

Plain truth: OpenSpec adds a step. You write a short plan before building. So what do you get for it?

  • You catch wrong turns before they cost you. Fixing a misunderstanding in a one-paragraph proposal is free. Fixing it after the AI wrote 400 lines is not.
  • The plan and the code stay in the same repo. Six months later, the spec tells you (and the next AI session) why the system works the way it does.
  • Changes are reviewable. A change folder is a tidy package: read the proposal, skim the deltas, check the tasks. No archaeology through chat history.
  • It fits existing codebases. Deltas mean you can specify a change to a 50,000-line app without first documenting the whole thing.

And the honest tradeoff: for a truly trivial one-line fix, the ceremony may not pay off, and that's fine. OpenSpec is designed to be lightweight, but it isn't free. Use it where agreement matters, which turns out to be most of the time once you're working with an AI that will confidently build whatever you vaguely asked for.

Where to go next