Description
write-openspec-docs is an agent skill from the OpenSpec project that switches an assistant into docs-writing mode for OpenSpec's user documentation. It loads the house style guide, writing.md, which is the authority for everything drafted, and then drafts or revises pages in that voice. The guide asks for a retrieval-first page: the structure decides whether a reader finds the answer, so each section opens with the answer rather than a story. The skill tells the writer to choose the page type before the outline. Guides follow the reader's task, while reference pages mirror the product's structure and use exact names of fields, commands and files as scan anchors. Plain words are preferred, with no hype adjectives, no preamble and no em dashes, and each sentence carries one fact. Inventories open with a list naming every item, and sequences use numbered steps. Load-bearing facts sit on a scan anchor such as a code fence, a bold lead-in, a table or a file tree, never only in the middle of a paragraph. Before finishing, the writer runs two checks: whether each question can be found by scanning alone, and whether the rendered page looks finishable at desktop and narrow widths. It is for contributors to the OpenSpec docs. Install it with npx skills add https://github.com/fission-ai/openspec --skill write-openspec-docs.…
Highlights
- Loads the OpenSpec house style guide before drafting
- Answer-first sections with scan anchors
- Separate approach for guides and reference pages
- Retrievability and rendered-page checks before finishing
Ratings & Reviews
No ratings yet
Be the first to rate write-openspec-docs.
People also visit
verify-openspec-docs
Fact-checks OpenSpec user documentation with a fresh-context subagent
understand-onboard
Generate an onboarding guide for new team members joining a project
code-documentation
The user requests to generate, create, or improve documentation for code, APIs
write-openspec-docs FAQ
What style does it follow?
The house style guide writing.md in the OpenSpec docs, with action-first sections, one fact per sentence and no preamble.
What is the difference between a guide and a reference page?
Guides follow the reader's task. Reference pages mirror the product's structure and use exact names as scan anchors.
Does it verify the facts?
No. It drafts and revises. Fact-checking is handled by the separate verify-openspec-docs skill.
How do I install it?
Run npx skills add https://github.com/fission-ai/openspec --skill write-openspec-docs.
Which security audits does it have?
On skills.sh, Gen Agent Trust Hub and Snyk pass, and Socket shows a warning.
What are the best write-openspec-docs alternatives?
Popular alternatives to write-openspec-docs include draft-openspec-docs, verify-openspec-docs and docs-write. See all write-openspec-docs alternatives