マニュアルを作成するコツ《その1》
まずは、マニュアル記事の全体の構成を考えてみましょう。
あまりに長くなるようであれば、前編・後編に分けてそれぞれリンクを貼ったり、1記事で全部を説明しようとせずに「作業前の準備」「○○から●●まで」「●●から△△まで」と作業ごとに範囲を限定して、個別にマニュアル記事を作ったりすると良いかもしれません。
マニュアルの目的は、自分の持っている仕事のノウハウを、他のスタッフに共有することです。
何も予備知識がないスタッフを想定して、
どこから説明すると伝わりやすいかな？これは専門用語だからわかりにくいかな？細かい部分を説明する前に、先に大まかな流れを説明したほうがいいかな？手順などの方法論だけでなく、作業の目的を書くと理解してもらいやすいかな？
などなど、いろいろ考えて、初めてその仕事を行うスタッフに伝わるように書いてみてください。
HomeBaseでは、マニュアル作成に役立つさまざまな編集機能を備えています。
- 箇条書きにする
- 作業手順に番号をふる
- 重要な箇所、大事なポイントを装飾や囲みなどで強調
- 文章だけで説明しづらいところは、スクリーンショット、写真等を加工して掲載
- たとえ話などを挟む
- 専門用語ははじめに説明する
- etc