Skip to content
cccskills
FreePublished on GitHub

write-openspec-docs

Draft and revise OpenSpec user documentation using its house style. Organize task guides and reference pages so readers can quickly find answers, commands, file paths, and troubleshooting details, while identifying claims that remain unchecked.

OriginalShow the original description

Switches into OpenSpec docs-writing mode; loads the house style guide and drafts or revises pages in its voice (action-first, no preamble, scannable). Use when writing or editing pages in the OpenSpec docs tree.

See how to install

Good for

  • Drafting an OpenSpec task guide
  • Reorganizing a command reference
  • Revising documentation for easier scanning

Files included (3)

  • SKILL.md3.7 KB
  • full-process.md3.1 KB
  • writing.md17.2 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

Write OpenSpec docs

You are now writing OpenSpec's user docs. Read writing.md; it is the style authority for everything drafted here. The short version, in effect immediately:

  • A page is a retrieval surface, not an essay. Structure decides whether the reader finds the answer; prose only decides how it reads. Open every section with the answer, never a running story.
  • Choose the page type before the outline. Guides follow the reader's task; reference mirrors the product's structure and uses exact field, command, and file names as scan anchors. Reference needs complete coverage without compressing several facts into one sentence, cell, or paragraph.
  • Draft the shortest version that answers; expanding a spare page is cheap, cutting a bloated one is a rewrite. Plain words, the fewest of them: an idea that fits in one line takes one line. Depth most readers skip goes behind a link, and the payload (commands, real output, failures and fixes) stays whole.
  • Dumb sentences, smart structure. Write the obvious sentence (actor, verb, object, stating the literal event); never compress extra facts in or take an angle. No hype adjectives, no preamble, no em dashes.
  • One job per slot: one fact per sentence, list intros only announce the list, one reader question or lookup target per section. A related fact gets its own slot, never a ride in someone else's.
  • Ground items in what the reader can verify: path or folder first, concept as the gloss, real output shown honestly.
  • No house template. Inventories open with a list naming every item, then expand each in its own unit after the list, never inline. Sequences take numbered steps (numbers mean order; inventories take bullets). Single ideas and reasoning stay in short prose.
  • Every load-bearing fact sits on a scan anchor: code fence, numbered bold lead-in, **Term**: fact bullet, table, file tree. Never only mid-paragraph.
  • Before finishing, run two backstop tests. Retrievability: can each question or exact product name be found by scanning alone? The glance: inspect the rendered page as shapes; does it look finishable, or like work? Check table-heavy changes at desktop and narrow widths. A failure means a slot got written without being earned; fix it now, don't leave it for review.

Ground rules

  • Load the no-ai-slop skill before drafting; it owns the generic slop patterns, while writing.md owns what OpenSpec's docs specifically look and sound like.
  • Read the target page in full before editing it.
  • Real facts only: flags, paths, and output as they exist in source. If a claim can't be checked cheaply, still write it, but name it as unchecked when you show the work; never bridge a gap with a plausible-sounding sentence.
  • A fact lives on one page; everywhere else links to it. The docs tree's README owns the page map and structural invariants; check it before restructuring or adding pages.
  • For reference pages, inventory the contract from source before drafting prose. Follow the reference process in writing.md.
  • When unsure how something should scan or sound, match the exemplars: docs-lab/start/setup.md for section shape and inventories, docs-lab/start/installation.md (Uninstalling) for multi-step tasks.

When done

Show the user what changed and name any unchecked claims.

If the user asks for the deep, evidence-first drafting session (run every command, one section per sitting, formal checkpoints), follow full-process.md.

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Draft or rewrite an OpenSpec documentation page collaboratively. The skill records its purpose and structure inside the page, writes one section at a time as requested, then updates related references and removes the working plan.

  • Shape a new documentation page together
  • Rewrite a page from scratch
  • Review and draft one section at a time
Fission-AI/OpenSpec72.4KUpdated Oct 17, 2026

Implement pending tasks from an OpenSpec change using its specifications and design documents. The skill updates task checkboxes, confirms progress, supports resuming unfinished work, and pauses when requirements or implementation issues need clarification.

  • Start implementing a planned OpenSpec change
  • Resume partially completed implementation
  • Track completed and remaining tasks
Fission-AI/OpenSpec72.4KUpdated Oct 17, 2026

Finalize an implemented OpenSpec change by checking planning files, task completion, and specification differences. Review whether to merge specification updates, verify any requested merge, then archive the change and report its location and outstanding warnings.

  • Archiving an implemented change
  • Reviewing specification updates before archiving
  • Checking unfinished work before closing a change
Fission-AI/OpenSpec72.4KUpdated Oct 17, 2026

Archive several OpenSpec changes together after reviewing their documents and task progress. The skill checks code to resolve overlapping specification updates, syncs the selected updates, and reports which changes were archived, skipped, or failed.

  • Archive several completed changes together
  • Resolve overlapping specification updates
  • Review unfinished work before archiving
Fission-AI/OpenSpec72.4KUpdated Oct 17, 2026

Continue an existing OpenSpec change by creating one planning artifact, such as a proposal or specification, per request. Read its dependencies and workflow instructions, complete missing files when needed, and report progress and newly available steps.

  • Resuming an existing change plan
  • Creating the next planning document
  • Completing files missing after an interrupted draft
Fission-AI/OpenSpec72.4KUpdated Oct 17, 2026

openspec-explore

FreeSummary

Explore ideas, investigate problems, and clarify requirements in an OpenSpec project through discussion grounded in existing code and specifications. Compare approaches, sketch diagrams, and identify open questions, with planning documents saved only within an explicitly approved scope.

  • Clarify the scope of a loosely defined feature idea
  • Compare technical approaches using project evidence
  • Revisit design choices when implementation gets stuck
Fission-AI/OpenSpec72.4KUpdated Oct 17, 2026

See all skills by Fission-AI

Report a problem with this skill