write-docs について
write-docsは、BrowserOSの機能ドキュメントを簡潔に作成するエージェント向けスキルです。コード調査からスクリーンショット収集、執筆、ナビゲーション更新、プレビューまでを案内します。
主な機能
- 01構造化された執筆ワークフロー
- 02GrepとGlobによるコード調査
- 03スクリーンショット収集の案内
- 04MDXページの作成
- 05ナビゲーション更新とプレビュー
活用シーン
- 01BrowserOSの機能を文書化
- 02コードベースで実装の詳細を調査
- 03ドキュメントのナビゲーションにページを追加
- 04ローカルプレビュー用のページを準備
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/write-docsを入力して読み込まれたか確認します。
詳細
BrowserOS のドキュメントを作成する
このスキルは、BrowserOS の機能に関するドキュメントの作成を支援します。構造化されたワークフローに従い、高品質で簡潔なドキュメントページを作成します。
ワークフロー
ステップ 1：機能を理解する
ドキュメントを作成する前に、コードベースを調べて機能を理解します。
- ユーザーに尋ねる：どの機能をドキュメントにしたいかを確認します
- コードベースを検索する：
../browseros-server（兄弟ディレクトリ）を調べ、関連するコードを見つけます。Grepを使って、機能に関連するキーワードを検索しますGlobを使って、関連するファイルを見つけます- 主要なファイルを読み、機能の仕組みを理解します
- 重要な要素を特定する：
- この機能はどのような問題を解決しますか？
- ユーザーはどのように有効化／設定しますか？
- 主なユースケースは何ですか？
ステップ 2：スクリーンショットを用意する
ドキュメント用のスクリーンショットをユーザーに提供してもらいます。
- ユーザーに伝えます：「[特定の UI 要素] が表示されたスクリーンショットをクリップボードにコピーしてください（Cmd+C）」
- 次を実行します：
python scripts/save_clipboard.py docs/images/<feature-name>.png - 必要に応じて、追加のスクリーンショットについても繰り返します
ステップ 3：ドキュメントを作成する
次の構成に従って、docs/features/<feature-name>.mdx（または適切な場所）に MDX ファイルを作成します。
---
title: "Feature Name"
description: "One sentence describing what this feature does"
---
[Opening paragraph: 1-2 sentences explaining what the feature does and why it matters]
## How It Works
[Explain the core mechanics in 2-3 paragraphs max]
## Getting Started
[Step-by-step instructions to use the feature]
1. Step one
2. Step two
3. Step three
## [Optional: Additional Sections]
[Only if necessary - keep the doc to ONE PAGE maximum]
ステップ 4：ナビゲーションを更新する
新しいページを docs/docs.json の navigation.groups 配列内にある適切なグループに追加します。
ステップ 5：プレビューする
ドキュメントをプレビューするため、ユーザーに docs/ ディレクトリで mint dev を実行するよう伝えます。
ドキュメントのスタイルガイド
- 簡潔に：ページの長さは最大 1 ページです
- 明確に：BrowserOS を初めて使うユーザー向けに書きます
- 実用的に：内部の実装詳細ではなく、機能の使い方に重点を置きます
- 視覚的に：説明だけでなく、スクリーンショットを使って示します
- 無駄を省く：不要な導入や結論は省きます
例：広告ブロックのドキュメント構成
---
title: "Ad Blocking"
description: "BrowserOS blocks 10x more ads than Chrome out of the box"
---
BrowserOS ships with built-in ad blocking that works immediately—no extensions required.
## How It Works
[2-3 paragraphs explaining the mechanics]
## BrowserOS vs Chrome
[Comparison with data/screenshots]
## What This Means
[1 paragraph on the practical benefits]
主なディレクトリ
- ドキュメントの場所：
docs/ - 画像：
docs/images/ - 機能のコード：
../browseros-server/（兄弟ディレクトリ） - 設定：
docs/docs.json
ドキュメント化する主な機能
ユーザーによると、次の機能のドキュメントが必要です。
- BrowserOS MCP サーバー
- BrowserOS アシスタントへの他の MCP の接続
- スケジュールされたタスク
- ［コードベースで見つかった追加機能］
コメント
Markdown 対応