ドキュメントは、チュートリアルのもう半分
動画を見る人もいれば、流し読みする人もいます。そして検索エンジンがインデックスするのは文字です。動画と文章のガイドを別々に作れば、同じウォークスルーを2回書くことになります。Captureはナレーションをクリーンにできるほどチュートリアルを理解しているため、文章版も同じ作業から生まれます。
Generate guideの仕組み
- いつも通りチュートリアルを編集します。 カットやトリミングはガイドにも反映されます。
- エディターでGenerate guideをクリックします。 プロジェクトにまだトランスクリプトがない場合は、Captureが先に文字起こしを行います。
- Captureがガイドを作成します。 トランスクリプト（最適化したナレーションがあればそちらを優先）とクリック操作から、タイトル、導入文、番号付きの手順を書きます。
- 各ステップにスクリーンショットが付きます。 クリックした瞬間の録画から取得し、動画内のその場面にジャンプするリンクも追加されます。
後で編集内容を変更すると、ガイドに「古い」マークが付きます。再生成すれば、再び内容が揃います。
実演したほうが早い人のための、ソフトウェアドキュメントの書き方
ヘルプセンターを管理している人に、ドキュメント作成に時間がかかる理由を聞いてみてください。タイピングだと答える人はいません。手順の順番を決めること、無意識に飛ばしてしまう前提条件を思い出すこと、そして初めて見る人でも迷わないほど正確に、画面を記憶から説明することです。
タスクを実演すれば、この3つがすべて解決します。製品の仕組み上、正しい順番で手順を踏むことになり、前提条件も実際に行うので記録され、録画が画面そのものなので説明も正確です。あとは白紙に向き合うのではなく、下書きを編集するだけです。
良いドキュメントには、何が重要かを判断する人間が今でも必要です。ただ、自分のクリック操作を書き起こす人間は、もう必要ありません。
Braiv Captureにおける位置づけ
ガイドは、ナレーション最適化をベースにしたBraiv Captureのロングテール機能です。ガイドはチュートリアルの元の言語で作成されます。すでにYouTubeにある動画から文章のガイドを作成したい場合は、YouTube動画からサポート記事を作成をご覧ください。
