テクニカルライターは、ユーザーマニュアル、APIドキュメント、「How to」ガイドなど、さまざまなタイプのドキュメントを作成します。 ユーザーマニュアルの書き方について記事を書きましたので、今日は「ハウツー」ガイドの作成について説明します。
ガイドを作成するタスクを受けたら、最初のステップは計画することです。
ターゲットオーディエンスを理解する
ガイドを書き始めるとき、ターゲットオーディエンスが誰であるかを明確に理解する必要があります。 年齢層はどのくらいか、どのようなバックグラウンドがあるかなどです。 これにより、使用する言語の複雑さ、用語の数、その他多くの特徴など、最も基本的なレベルで「ハウツー」ガイドのスタイルが決まります。
プロセスに関する調査
「ハウツー」ガイドの執筆における他の人の経験について読むことをお勧めします。 今後の仕事のイメージが湧きやすくなりますし、他の人のアプローチを自分の作業プロセスに取り入れることができます。 例えば、アムルート・ラナーデのテクニカルライティングプロセスについて書きました。その記事はこちらで読むことができます。 素晴らしいテクニカルライティングプロセス」。
有用な資料を集める
書き始める前に、「ハウツー」ガイドを書くのに役立つ資料や情報を集めます。 製品に関する追加情報、類似製品に関する他の「ハウツー」ガイドなどでも構いません。
Write Your ‘How-to’ Guide
まず、プランを作成します – イメージすればガイドを書くのは容易になるでしょう。 これらの準備が終わったら、いよいよ執筆開始です。 ガイドを作成している間、次のヒントを心に留めておく必要があります:
- 読者と同じ言語を話すために、平易な英語で書く
- 言語は常に簡潔にする（例,
- ユーザーがステップを完了する必要がある場合は、番号付きリストを作成して構成する
- 写真、スクリーンショット、図などのビジュアルコンテンツを追加する。
- コンテンツを見出し付きのセクションに分割し、明確に書く
- ジョークを使いたい場合は注意する: 人々があなたを理解できないかもしれない
- ミニTOCを追加して大きな話題を読みやすくする
最も重要なヒントは次のとおりです – スペルと文法の間違いはドキュメントでは容認できないため、ガイドを徹底的にチェックすること。 ここにTop Free Grammar Checkersのリストがあります。 また、誰かに校正を依頼したり、自分の書いた手順を逆に読んで、自分の文章が明確でシンプルであることを確認することもできます。
- Grammar Books for Technical Writers
- Style Guides for Technical Writers
もちろん、「How to」ガイドを書くために知っておくべきことはこれですべてではありませんが、これらのヒントが最も重要だと私は考えています。 あなたのお役に立てれば幸いです。
Good luck with your writing guides!
.