カテゴリー

ハウツー記事テンプレート

著者: アトラシアン

どんなことにも取り組むようチームに伝える

テンプレートを使用する
ハウツー記事テンプレート

仕事を完遂するために、私たちは日々、数百もの些細な (そして重要な) ことをこなしています。そのなかには何も考えずとも手が動くものもたくさんあります。しかし、自分にとってはありふれた作業でもそれを難しいと感じる人もいます。そこでハウツー記事テンプレートの出番です。このテンプレートでは、ブログの立ち上げ方やパスワードの変更方法、給付金割り当ての更新方法など、自社におけるあらゆる作業を詳細なステップにまとめられます。誰でも学び取れるため、時間の節約につながります。

ハウツー記事 テンプレートの使用方法

ステップ 1. 自分の業務を整理する

これから作成するハウツー記事は、所属しているチームや企業が大量のタスクを処理し、障害を克服して製品リリースまでの期間を短縮するための礎となるものにします。自身が特定のタスクのエキスパートであっても、少し時間をかけて同僚が実践しているプロセスを確認してみるだけの価値はあります。同僚にメモしてもらったベストプラクティスと比較して、自分のやり方やこれから作成するドキュメントに取り入れられるものがないか検討します。

タスクについてよく聞かれる質問と、読み手にとってわかりにくそうな部分への事前回答を検討します。自身でも時間をかけて編集を重ね、1 つずつ見直すようにします。給与ポータルの口座振込情報を更新する方法を例にしてみます。作業を始めるにあたってどのような質問があがりそうでしょうか (「処理にどれくらい時間がかかりますか?」)。最初のステップはどのようなものでしょうか (ポータルに登録してサインインする)。時間を節約するにはどうすればよいでしょうか (10 分間何も操作しないとポータルがタイムアウトするため、作業を始めるときに銀行の支店コードと口座番号を手元に用意しておく)。

ステップ 2. 概要を作成する

すべての事実と役に立つ情報を書き出しましたか? ここからは、実際にタスクを完了させるための各ステップの概要を作成していきます。概要にはなるべく詳細な情報を盛り込むようにします。概要がうまくまとまっているとハウツー記事の作成もはるかに簡単になります。また、ステップの数を 3 ~ 5 個に収めるようにすることで、プロセスにはそれほど時間がからないと読み手に感じてもらえます。

文章を読むことで知識を吸収する人もいれば、視覚的要素や音声から吸収する人もいます。また、これらをすべて組み合わせて知識を吸収する人もいます。概要を作成するときは、用意した図やグラフィック、動画、スクリーンショットに関する説明を記入するか、イメージしやすい指示を記載するようにしましょう。

ステップ 3. 図、グラフィック、スクリーンショットを用意する

目で見て確認できる素材があれば親しみが生まれ、ハウツーも使いやすくなります。クリエイティブ素材のライブラリがすでにあればそれほど難しいステップではありません。ライブラリがない場合は、クリエイティブチームやサードパーティベンダー、または素材の開発と取りまとめを手伝ってくれる人と相談してみてください。プロからのヒント: 無料のスクリーンショットブラウザプラグインやオンラインのデザインツールを使って素材を自分でも作れます。

プロセスに関連するコンテキストへのリンクも集めます (支払いスケジュールなど)。プロセスフローとは直接関係しませんがきっと役に立つはずです。

ステップ 3. 図、グラフィック、スクリーンショットを用意する

ステップ 4. セカンドオピニオンとサードオピニオンを聞く

まとめた概要は申し分なく、必要なステップもすべて組み込まれています。ここからは、抜けている点がないか、より詳しい説明が必要なステップがないかを確認していきます。該当するプロセスに詳しい人に概要を見せて、何か追加できるものがないか確認してもらいましょう。

Confluence テンプレートを使って、作成した概要をハウツー記事として成り立つように具体化します。下書きが完成したら、プロセスの流れをまったく知らない人に読んでもらいながら、実際にプロセスを進めてみてもらいましょう。スムーズに進められましたか? 引っかかる点はありませんでしたか? 問題はどこにありましたか? 下書きを見てくれた人が行き詰まってしまった箇所の指示を書き直しましょう。

ステップ 5. ハウツーを公開してフィードバックを集める

準備がすべて整ったらハウツー記事を公開します。ハウツーを公開することは、やり方がわからない人や途中で行き詰まっている人の助けになるとともに、同じ質問に何度も答える時間も節約できます。情報収集と確認に十分な時間をかけたとしても、社内にはまだ疑問を持ったり、混乱したりする人もいるかもしれません。

Confluence の優れた点は、コンテンツを誰でも編集できるところです。サポートが必要な部分があれば誰でもそこにコメントを残せます。また、必要に応じて編集を加えられるので、ドキュメントは常に新鮮な状態を保てます。チームのニーズとオペレーションの変化に合わせて自由にドキュメントを進化させられます。


アトラシアンは、ソフトウェア開発者、プロジェクトマネージャー、コンテンツ管理向けの製品を開発するエンタープライズソフトウェア会社です。

  • AWS architecture diagram template

    Lucidchart

    AWS アーキテクチャ図

    インフラストラクチャを視覚化し、弱点と改善点をより正確に特定します。

  • DevOps runbook template

    アトラシアン

    DevOps ランブック

    運用チームが素早くシステム アラートや障害に対応できるよう準備します。

  • DevOps change management template

    アトラシアン

    DevOps 変更管理

    このテンプレートを使用して変更管理パフォーマンスを評価し、リスクを軽減します。