Write Openspec Docs

作者 fission-ai9111a7654d78無授權條款71K 個星標收錄於 2026年10月8日更新於 2026年10月8日儲存庫今天更新

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.

僅含說明Writing & Content
AI 產生的概覽

依照 OpenSpec 內部風格起草或修訂使用者文件頁面,強調結論先行、方便掃讀。

功能
這個技能會讓代理進入 OpenSpec 文件撰寫模式,載入專案風格指南,並依其語氣起草或修訂頁面。它把頁面視為檢索介面,先決定頁面類型再擬大綱,每節開頭直接給出答案,並把關鍵事實放在程式碼區塊、表格、粗體引導語等可掃讀錨點上。完成前還會做可檢索性與視覺可掃讀性兩項檢查,並說明變更內容及未經查證的說法。
適用情境
適用於撰寫或編輯 OpenSpec 文件樹中的頁面,包括指南頁與參考頁。適合需要依 OpenSpec 特定風格規則,把頁面組織成方便掃讀結構的任務,而非一般性的文字潤飾。
執行需求
要求代理在起草前載入 no-ai-slop 技能,並閱讀隨附的 writing.md 風格指南;full-process.md 僅用於更深入的證據優先撰寫流程。需要存取目標 OpenSpec 文件樹,以及關於旗標、路徑與輸出的真實來源資訊。不附帶指令碼,僅為指示。

Write OpenSpec docs

You are now writing OpenSpec's user docs. Read writing.md [blocked]; 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 [blocked] 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 [blocked].
  • 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 [blocked].

來源與署名

來源:fission-ai/openspec位於.agents/skills/write-openspec-docs提交9111a76

授權條款: 無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架