お問い合わせ

マニュアル粒度設計

読み
まにゅあるりゅうどせっけい

マニュアル1件あたりの範囲と詳しさを、事前に決めておくこと。

解説

マニュアル粒度設計は、マニュアル1件が扱う業務の範囲と説明の詳しさについて、作成を始める前に基準をそろえておく作業です。粒度の基準を決めずに複数人で書くと、文章量も文書の分け方もばらばらになりやすくなります。その結果、後から基準をそろえる作業に、一から作成する以上の工数がかかることもあります。ばらつきの原因の一つは、読み手が探しているのが業務の全体像か目の前の1操作かという想定が、書き手の間で食い違ったまま作成が進むことです。

判断基準

1件を細かく割りすぎると、横断する手順が追えなくなります。具体的には、1件を小さくすると検索性は上がりますが、複数の文書を行き来しないと一連の作業が終わらなくなります。反対に、1件を大きくまとめると、必要な箇所にたどり着くまでのスクロールが増えます。したがって、粒度を判断するときは、応対中に参照する文書か、研修時に通して読む文書かという用途の違いを目安にします。

実務での使われ方

粒度設計では、1件の範囲と詳しさを書き始める前に決めます。主に決めておく項目は次のとおりです。

  • 1件で扱う業務の単位(業務全体か、作業1つか)
  • 前提知識をどこまで想定するか
  • 例外ケースを本文に入れるか、別途分けるか
  • スクリーンショットをどのステップに付けるか

決めた内容は口頭で共有するのではなく、見本となる1件を先に書いて全員に配るのが確実です。文章で基準を説明するよりも、実物を1つ示したほうが、書き手の間で粒度がそろいやすくなります。

注意点

例外の置き場所を決めておくと、本文が読みにくくなることを防げます。まれにしか起きないケースを本文に差し込んでいくと、標準の手順が読み取りにくくなるためです。そのため、例外は末尾にまとめるか別記事に切り出し、本文からは条件と参照先だけを示す形にします。この形にしておけば、追記が続いても構成が崩れにくくなります。