Draft Openspec Docs

fission-ai/openspec/.agents/skills/draft-openspec-docs

作者 fission-ai9111a7654d78无许可证71K 个星标收录于 2026年10月8日更新于 2026年10月8日仓库今天更新

Collaborative page-drafting mode for the OpenSpec docs. Builds a scratch plan inside the target page (purpose, structure, numbered draft steps), iterates on it with the user, then drafts one section per approved step and cleans up after itself. Use when a page needs a from-scratch rewrite or a new page is being shaped with the user in the loop.

AI 生成的概览

引导一种协作式的页内工作流,用于逐节规划并起草 OpenSpec 文档页面。

功能
该技能在目标文档页面内运行一套草稿计划工作流:先把页面精简为标题和目标行,再添加一个临时计划区,涵盖用途、结构和编号的起草步骤。计划会与用户反复迭代直至获批,随后按每个获批步骤起草一节,并对事实进行来源核验。最后整合交叉引用并清理临时区块。
适用场景
适用于 OpenSpec 文档页面需要从零重写,或在用户参与评审的情况下塑造新页面的场景。适合用户在起草前参与并批准结构的工作。
运行要求
仅为指令,不附带脚本。需要目标页面、OpenSpec 文档仓库中的 docs-lab/README.md 与 docs-lab/message-map.md、网站同步配置 website/docs.sync.config.mjs,以及用于校验的 Node 脚本 website/scripts/sync-docs.mjs。起草前还要求加载 write-openspec-docs 与 no-ai-slop 技能。

Draft OpenSpec docs (scratch-plan workflow)

You are shaping a docs page with the user in the loop. The page is planned and reviewed inside the page itself, then drafted one section at a time. Load write-openspec-docs (the style authority) and no-ai-slop before drafting anything.

1. Set up the scratch section

Strip the page to its title and > goal line, then add a working section below them:

md
## Scratch: page plan (delete before publish)
### Purpose
### Structure
  • Purpose: 3-5 dot points. Who the reader is and what they come to look up, what the page covers, what it links out to. Check docs-lab/README.md (the page's goal line) and docs-lab/message-map.md (the questions routed here) before writing it.
  • Structure: a numbered list of the page's sections, one line each naming the section and the shape of its content (table, fence, tree, bullets).
  • Say what the page will do, never what it won't. Plain words and short bullets; the user reads this in their editor.

2. Iterate until the plan is approved

  • Plan edits are cheap; page edits aren't. Reshape the plan as many times as the user asks before drafting.
  • Record every decision in the plan itself, not only in chat. Add a ### Notes list for follow-ups that belong to other pages and product observations found along the way.
  • The user may edit the file directly between turns; their edits are decisions, not drift to revert.
  • Surface one open call at a time, with a recommendation.

3. Add the draft plan, then draft step by step

Once the structure holds, add a ### Draft plan below the notes: one step per page section, each with an ID and a readable title (**D1. Goal line and intro**), ending with a consolidation step (cross-page updates) and a cleanup step. Then:

  • Wait for the user to call a step ID. Draft exactly that step, into the page above the scratch block.
  • Verify each fact against source before writing it; a cheap grep beats trust. Reference content shows the raw contract (templates, instructions, config) verbatim in fences, linked to the file on GitHub, rather than paraphrasing it.
  • Keep sibling sections on a repeatable sub-structure so the page scans as one system.
  • Mark the step (done) in the plan, report what landed, and name the next step.

4. Consolidation and cleanup

  • Consolidation: update everything that points at the page. The README goal line (verbatim match with the page's > line), the message map, the sync config (website/docs.sync.config.mjs), and any cross-links found by grepping the tree. Run node website/scripts/sync-docs.mjs to validate.
  • Cleanup: delete the scratch block, run the retrievability and glance tests from write-openspec-docs at desktop and narrow widths, and flip the page's message-map row to Answered if its prose landed.

来源与署名

来源:fission-ai/openspec位于.agents/skills/draft-openspec-docs提交9111a76

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架