User Guide Skill
スキル読み込み通知
このスキルが読み込まれたら、必ず以下の通知をユーザーに表示してください:
💡 User Guide スキルを読み込みました
ユーザー向けの取扱説明書を作成します。
When to Use
- •アプリケーションの取扱説明書・ユーザーガイドを作成したいとき
- •各機能の使い方を丁寧に説明したドキュメントが必要なとき
- •エンドユーザー向けの操作マニュアルを整備したいとき
- •README よりも詳しい使い方ガイドを作成したいとき
- •「このアプリの使い方を人に説明したい」とき
- •新しい機能を追加した後、ガイドを更新したいとき
- •FAQやトラブルシューティングを含む包括的なドキュメントが必要なとき
ガイドラインと方針
ホスピタリティの原則
ユーザーガイドはユーザーが困らないことが最優先です:
- •初見でも分かる説明: 専門用語は避け、平易な言葉で説明する
- •操作手順は具体的に: 「ボタンを押す」→「画面上部の ▶ ボタンをクリック」
- •つまずきポイントを先回り: よくある質問やトラブルシュートを含める
- •視覚的に分かりやすく: 表、箇条書き、注意書きを活用する
README との違い
| 観点 | README | ユーザーガイド |
|---|---|---|
| 対象 | 開発者・技術者 | エンドユーザー |
| 深さ | セットアップ中心 | 操作方法の詳細 |
| 技術用語 | 使用する | 極力避ける |
| コードの記載 | あり | なし(操作説明のみ) |
機能抽出の手順
ユーザーガイドを生成する前に、実際のコードから機能を網羅的に抽出します。 抽出対象、抽出方法、Turtle Video の機能カテゴリ一覧は以下を参照してください:
📄 references/feature-extraction-guide.md
ユーザーガイド テンプレート
以下のテンプレートに沿ってガイドを生成してください:
テンプレートおよび参照ドキュメントに従い、Turtle Video の9つの機能カテゴリに沿ったガイドを生成してください。
記述のポイント
- •操作対象はUIの見た目で説明する(例: 「🔊 アイコン」「スライダーを左右にドラッグ」)
- •数値の設定範囲がある場合は必ず明記する(例: 「0.5秒〜60秒の範囲で設定」)
- •ロック機能のように間接的に操作に影響する機能は注意書きで触れる
- •スクリーンショットや図を追加する場所には
[スクリーンショット: ○○]のプレースホルダーを入れる