本文へ移動

使われるマニュアルの作り方とは?試行と更新担当を決める方法

概要

マニュアルを作る際は、初めて使う人が実際の作業を完了できるかを試します。この記事では、目的と準備の説明、利用者の試行と更新の運用を解説します。具体例を通して、実際の仕事で使う際の判断基準と注意点も紹介します。

公開日
更新日

マニュアルは実際の作業で試して更新を続ける

マニュアルを作る際は、初めて使う人が実際の作業を完了できるかを試します。手順の正しさだけでなく、探す場所、例外、相談先も記載します。

作成後には更新する担当者と契機を決めます。資料が存在することと、現場の条件に合って使われることを別々に評価します。

作業の目的と必要な準備を先に書く

受付処理なら、必要な情報、利用権限、完了後の状態を示します。手順の途中で初めて必要な資料を知る構成を避け、準備を先に説明します。

例外には対応する条件と相談先を記載します。画面の画像だけに頼らず、操作の理由も短く添えます。

初めて使う人の作業を観察する

担当者に資料を使って作業してもらい、探せなかった内容と止まった箇所を記録します。説明者がすべて口頭で補うと、資料だけで理解できるかを評価できません。

GOV.UKの利用テストは、課題を試す行動を観察します。(GOV.UK: Moderated usability testing)

変更と質問を更新につなげる

画面、受付条件、権限が変わったら資料も更新します。同じ質問が繰り返される場合は、その内容を手順や例外へ反映してください。

公開する利用案内には社内だけの情報を混ぜず、必要な説明を掲載します。更新日と問い合わせ先も明記します。

更新する担当者が変わる際は、 仕事の引き継ぎ方 も参考になります。

SpreadSite は、Googleスプレッドシートで内容を管理し、テンプレートを使ってホームページを作成・公開・更新できるノーコードツールです。

公開できる利用手順を案内するホームページの作成に、ぜひ使ってみてください!

SpreadSiteでホームページを作成する →

よくある質問

Q: 手順を知る人の確認だけで十分ですか?

A: 初めて使う人の疑問は異なる場合があります。実際に資料を使う試行を加えます。

Q: 画像だけのマニュアルでよいですか?

A: 操作の対象、目的、例外を文章でも説明します。画面の変更にも対応します。

Q: 更新はいつ行いますか?

A: 業務の変更と利用時の質問を契機にし、定期的な見直しも設けます。

Q: 社内マニュアルを公開できますか?

A: 公開する情報を選び、内部記録や権限情報を除いた案内を作ります。

参考資料

スプレッドシートでホームページが作れるSpreadSite