any2.video
このページは機械翻訳されたもので、現在ネイティブスピーカーによる確認を進めており、正式な内容は英語版のページです: English
~/alternatives / technical-writer

any2.video とテクニカルライターの採用の比較:同じカバレッジの問題に対する、2つの答え

優れたテクニカルライターは、ソフトウェア企業ができる採用の中でも特に効果の大きいものの1つで、このページにはそれに反対する主張は何もありません。文章のドキュメントと検証済みの動画は、カバレッジの問題の別々の半分に答えるもので、どちらを選ぶかは、実のところ、いまどちらの半分が壊れているかという問題です。

それぞれの選択肢が証明するもの

質問テクニカルライターany2.video
何を生み出すか検索でき、リンクでき、修正できる文章。タスクが完了するまでの録画と、手順書。
「ボタンはどこ?」への答え方言葉で。読み手はそれを画面と照らし合わせる必要があります。見せることで。
「これは何のためにある?」への答え方とても得意です。文章はそのためのものです。苦手です。動画はリファレンス資料に向いていません。
カバレッジを広げる速さ文章だけなら速く、画面キャプチャが必要なものは遅くなります。1タスクあたり2日、まとめて制作。
どこで見つけてもらえるかお客様のドキュメントサイトと、検索エンジン。YouTubeとAIアシスタント。製品についての質問が投げかけられる場所です。
最新状態の維持規律とレビューの体制次第。バージョンタグと、リリースごとの再実行。

テクニカルライターが適しているのは、こんな場合

  • ドキュメントが不完全だったり、矛盾していたり、誰にも手入れされていなかったりする。まずはそれを直してください。質の悪いドキュメントの上に動画を作っても、誤りを広めるだけです。
  • 内容がリファレンス資料である:パラメーター、API仕様、制限事項、概念の説明。
  • 読み手が検索し、コピーし、リンクする必要がある。動画からコマンドをコピーする人はいません。
  • コンテンツを、リリースプロセスの横ではなく、その中に組み込む必要がある。

適していないのは、こんな場合

  • 手順は文章で書かれているのに、それでもユーザーが間違える。たいていは、画面が文章の説明どおりに見えていないということです。
  • 問われているのは「実際に動くのか」で、文章では決着がつかないが、画面上のエビデンスなら決着がつく。
  • 購入検討者がYouTubeで意見を形成していて、そこには自社のドキュメントが出てこない。
  • 採用したライターが、文章を書く代わりに、スクリーンショット作りで1週間を費やしている。

進める順番

まずドキュメントです。書かれた手順が間違っていれば、その手順の動画は、より説得力のある間違った手順になります。私たちはこの理由で仕事をお断りしたことがあり、同じ状況なら、またお断りします。

ドキュメントが正しくなれば、足りないのは情報ではなく、証拠と、画面を見て「これだ」とわかることです。手順を読んでもトグルを見つけられないユーザーに必要なのは、同じ文章をもう一度読むことではありません。画面を見ることです。

すべてのウォークスルーに文章が付きます

手順書とトラブルシューティングのメモを、追加販売の商品にせず料金に含めているのは、このためです。検証済みの実行からは、うまくいった手順が正確に、順番どおりに、失敗した試行とその対処とともに得られます。この成果物は、記憶ではなく実際の実行から生まれたものなので、既存のドキュメントより優れていることがよくあります。ライターはそれを、そのままドキュメントに取り込めます。

ライターにとっての利点

画面キャプチャは、テクニカルライターの仕事の中でもっとも価値の低い作業なのに、1週間を食いつぶします。検証済みの実行は、実際に起きたことをタイムスタンプ付きで記録したログをライターに渡します。それは、ライターが本来なら手作業で再構成するはずだった素材です。

よくある質問

テクニカルライターを採用すべきですか?それとも動画を購入すべきですか?

ドキュメントが間違っているか、存在しないなら、まずライターを採用してください。不正確なドキュメントをもとにした動画は、誤りを増幅させます。ドキュメントがしっかりしているのにユーザーが先に進めないなら、足りないのは情報ではなく証拠で、それを提供するのが検証済みウォークスルーです。

動画は自社のドキュメントの代わりになりますか?

いいえ。代わりにすべきでもありません。文章は検索でき、コピーでき、安価に修正できます。動画はリファレンス資料には向かず、タスクが完了するところを見せるのに向いています。

自社のライターが使えるものは受け取れますか?

はい。すべてのウォークスルーには、実行ログをもとに作成した、うまくいった手順の正確な記録と、失敗した試行が付きます。ほとんどのチームは、それをそのままドキュメントに貼り付けています。

決着をつけるいちばん早い方法は、1つのタスクを両方のやり方で作ってみることです。最初のサンプル動画は無料です。

$ get-sample → $ cd /library