開発者ツールやCLIの公開動画を作る方法
映像を飾る前に、入力、コマンド、有用な結果を示しましょう。 開発者向け動画には手順の信頼性が必要です。派手なコマンドの流れより、読める出力と正直な例が重要です。
相手が知る作業を1つ選びます。デプロイを簡略化するなら手順の減少、ファイル分析ならファイルと結果を示します。確認できない機能一覧から始めません。
再現できる例を使う
秘密情報のない小さなデモ用リポジトリや入力データを作ります。実際のバージョンと実行コマンドを記録し、可能なら入力も公開して再試行できるようにします。
長い待ち時間を除いたのに即時実行と見せないでください。無言で挙動を変えて見せるより、早送り表示や明示したカットを使います。
画面を絞り、細部を読みやすくする
OBSは録画の一部としてキャプチャに対応しています。サイトは「Windows、Mac、Linux」で利用できると説明しています（訳）。実際の環境に合う設定を選び、文字を大きくし不要なパネルを除きます。
ツールとコマンドが分かる文脈は残します。パス、入力、結果を隠す拡大は理解を妨げます。PCだけでなくスマホでも確認します。
公開動画の構成例
| 場面 | 見せるもの | 話す・書く内容 |
|---|---|---|
| 問題 | 導入前の作業 | 具体的な困り事1つ |
| 入力 | リポジトリ、ファイル、要求 | ツールへの入力 |
| 動作 | 意味のあるコマンド1つ | 今起きること |
| 結果 | 開発者が確認できる出力 | 役立つ理由 |
| 終わり | 文書や導入先 | 次の行動1つ |
これは絵コンテ案で、最適な順番の実測ではありません。正確に説明できる小さな例にします。
動画をコードで保守する場合
頻繁に変わるツールでは、見出し、枠、バージョン表示の再利用が役立ちます。Remotionのレンダーは構成情報と入力プロパティを受け取り、動画のプログラム制作に使えます。レンダー文書。
実際の端末出力と説明図を分けます。コード生成の動画で成功出力を捏造せず、説明用の場面はそう明示します。
次の行動を実行できる形にする
最後に読める文書URL、デモ、導入ページを置きます。速い映像から書き写させず、投稿にコピー可能なコマンドを載せます。例に影響する前提条件も示します。
公開告知にブランドに合った短い紹介動画が必要なら、Teasrはツールの公開サイトを制作依頼の出発点にできます。レンダリング用プロジェクトを作ったり、動画編集ソフトを覚えたりせずに、プロモーション動画を確認できます。コマンド動作が証拠なら実際の録画を使います。Remotionとノーコード生成、録画とアニメーションも参照してください。