draft-openspec-docs について
draft-openspec-docs は、ユーザーと OpenSpec ドキュメントを計画し、セクションごとに下書きするエージェントスキルです。ページ内に計画を記録し、承認後に執筆を進め、関連ページの更新と後片付けも手順に含めます。
主な機能
- 01ページ内に作業計画を記録
- 02ユーザーの承認まで計画を反復
- 03指定された手順ごとに執筆
- 04関連ページの更新と後片付けを含む
活用シーン
- 01ドキュメントページの構成計画
- 02ユーザーと文書の各節を段階的に執筆
- 03リンク更新と公開前のページ整理
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ fission-ai/ openspec --skill draft-openspec-docsインストール後、Claude Code で/draft-openspec-docsを入力して読み込まれたか確認します。
詳細
OpenSpec ドキュメントの下書き(scratch-plan ワークフロー)
ユーザーと相談しながら、ドキュメントページを作成します。ページ内で計画を立ててレビューし、その後、一度に1つのセクションを下書きします。下書きを始める前に、スタイルの基準となる write-openspec-docs と no-ai-slop を読み込んでください。
1. scratch セクションを設定する
ページをタイトルと > の目標行だけにし、その下に作業用セクションを追加します。
## Scratch: page plan (delete before publish)
### Purpose
### Structure
- 目的:箇条書きを3~5項目にします。読者が誰で、何を調べに来るのか、ページで何を扱うのか、どこにリンクするのかを記載します。書き始める前に、
docs-lab/README.md(ページの目標行)とdocs-lab/message-map.md(このページに振り分けられた質問)を確認します。 - 構成:ページのセクションを番号付きリストにし、各行にセクション名と内容の形式(表、コードフェンス、ツリー、箇条書き)を記します。
- ページで行うことを記載し、行わないことは書きません。平易な言葉で、短い箇条書きにします。ユーザーはエディター上で読みます。
2. 計画が承認されるまで繰り返す
- 計画の編集は簡単ですが、ページの編集はそうではありません。ユーザーが求める限り、下書きを始める前に計画を何度でも組み直します。
- 決定事項はすべて、チャットだけでなく計画自体に記録します。他のページで対応するフォローアップ事項や、作業中に見つけたプロダクトに関する所見を記す
### Notesリストを追加します。 - ユーザーはターンの合間にファイルを直接編集することがあります。その編集は決定事項であり、差し戻すべき変更ではありません。
- 未決事項は、一度に1つずつ推奨案とともに提示します。
3. 下書き計画を追加し、段階的に下書きする
構成が固まったら、Notes の下に ### Draft plan を追加します。ページの各セクションにつき1ステップを記載し、各ステップに ID とわかりやすいタイトル(**D1. 目標行と導入**)を付けます。最後に、統合作業(ページ間の更新)とクリーンアップのステップを追加します。その後、次の手順で進めます。
- ユーザーがステップ ID を指定するまで待ちます。指定されたステップだけを下書きし、scratch ブロックより上のページに追加します。
- 記載する前に、すべての事実をソースで確認します。信頼するより、簡単な grep のほうが確実です。リファレンスの内容は言い換えず、生の仕様(テンプレート、指示、設定)をコードフェンス内にそのまま記載し、GitHub 上のファイルにリンクします。
- 関連するセクションは繰り返し使える構成に統一し、ページ全体をひとつのシステムとして見渡せるようにします。
- 計画内のステップに
(done)を付け、追加した内容を報告して、次のステップを示します。
4. 統合とクリーンアップ
- 統合:ページを参照している箇所をすべて更新します。README の目標行(ページの
>行と完全一致)、メッセージマップ、同期設定(website/docs.sync.config.mjs)、ツリー全体を grep して見つけた相互リンクが対象です。node website/scripts/sync-docs.mjsを実行して検証します。 - クリーンアップ:scratch ブロックを削除し、
write-openspec-docsの検索性テストと一目でわかるかのテストをデスクトップ幅と狭い幅で実施します。また、本文が完成していたら、メッセージマップの該当行を Answered に変更します。
コメント
Markdown 対応