マニュアルって一体なんだろう?

「マニュアル」という言葉は,仕事をしている方は良く見聞きすることがあるかもしれません。筆者も学生時代にアルバイトをしていた時に何度も見聞きしました。
弊社でも情報システムを構築して納品する際に,お客様への納品物としてマニュアルを納品しています。ストレージ製品を扱っている店頭営業部でも,必ず製品ごとにマニュアルを添付して出荷しています。

そこで、今回は昨年秋に当blogで公開した「FreeNASで10GbEthernet対応の高速NASを作ってみた!」で取り上げた実験用NASのシステム運用マニュアルを書いてみました。

マニュアルといってもいろんな目的のマニュアルがあります。ユーザマニュアル、リファレンスマニュアル、クイックガイド、初心者マニュアル等です。今回の場合、あくまでシステム管理者にとって実用的で役に立つ視点で整理します。

マニュアルを書く前に押さえて置きたい事としては、事業の定義とユーザの技術水準です。自明のようでも、「これからの事業」「これからのユーザ」が変化することも組み込んでおきたいです。

マニュアルを書いた後に押さえて置きたいポイントは、読者との読み合わせです。実際に作ったものを読者に読んでもらい、意見を反映させることが大事です。

 

実際に作ってみた。

システムの概要はこちらのブログを参考にしてください。

FreeNASで10GbEthernet対応の高速NASを作ってみた!
https://www.amulet.co.jp/shop-blog/?p=8164

まずマニュアルの表紙と目次を見てみました(後半で、本文も掲載します)。

本システムの目的(=事業の定義)は、実験目的ながら最低限のバックアップを行って実用に耐えるファイルサーバを考えます。読者の対象は、システム管理者を想定し、コンピュータの知識は一通りあるものとします。
実際は、ここからユーザの要望に応じて、個別に文章、絵、写真などを追記していくことになります。

マニュアルって何だろう?

改めて「マニュアルって一体なんだろう?」と考えてみると,スパッと一言で言い表すのは難しいかもしれません。辞書で意味を調べてみると,以下のような結果が出てきました。

スーパー大辞林(日本語)

 

Google検索結果

辞書的には,「作業や操作の手順についてをまとめたもの」という解釈が一般的なようです。普段イメージするものとそれほど大差はありません。

対してGoogle検索で出てきた結果を見ると「日常生活に供するもの」と書かれています。

筆者はよくGoole検索のキーワード補完を使って,世の中でその言葉に関するどのようなことが検索されているのかを調べることがあります。今回も「マニュアル (スペース)」で検索してみました。

「意味」「英語」「作り方」などを調べている方が多いようです。他にも車に関することをイメージしているようです。

さて,では情報システムのマニュアルについてはどうでしょうか。

皆さん色々と苦労されているようです(筆者もその一人です)。当然ながら「これが正解!」というマニュアルの書き方は対象によって大きく異なるので一概には語れません。今回は,普段弊社法人営業部で整備しているマニュアルの書き方とあり方について少し書いてみたいと思います。
(情報システムに興味のない方は,最近出てきたThunderboltストレージの記事などを御覧ください)

マニュアルを5W1Hで考えてみる

弊社では,マニュアルが果たす役割として,先にGoogle検索で出てきたように「日常の業務で役に立ち,必要な時にサッと読めること」が大切であると考えています。あまりにも分厚いマニュアルでは項目を探すのも大変ですし,読むことそれ自体にも非常に時間と労力がかかってしまうからです。

そこで,「マニュアル」がどのような枠組みで使われることが多そうなのか,5W1Hで考えてみました。

  • いつ(when)
  • どこで(where)
  • だれが(who)
  • なにを(what)
  • なんのために(why)
  • どうやって(how)

マニュアルはいつ読む?(when)

多くの情報システム管理者の方は「トラブルが起こったとき」,「情報システムについて人に説明するとき」とか「仕様を確認したいとき」と答えるのではないでしょうか。これらはいずれも,その行動の先に「誰かに動いてもらいたい」という状況があると考えられます。

  • マニュアルにはこう書いてあるけど,その通りに動いていない
    →どうなってるか見て欲しい
  • このシステムはこういう風に動いている
    →動きを見てどうすべきか判断してほしい
  • このシステムのこの部分をこういう風に変えたい
    →今はこうなっているけど,こうしてほしい

つまり,マニュアルが参照される時は,「誰かに行動を起こさせるための情報伝達のソース(出典)となる時」ではないでしょうか。

マニュアルはどこで読む?(where)

「こんなことを考えている暇があったら仕事をしろ」と上司に怒られそうですが(笑),なかなか興味深い問いです。情報システムを管理運用しているデスクワークの多い方を想定してみます。

  • 自分のデスク
  • 書庫のような空間
  • 社内のサーバールーム(電算室)
  • データセンター
  • 社外(休日など?!)

普通に考えると,やはり「自分のデスク」か「書庫のような空間」が一番多そうです。マニュアルがまとめて入っているロッカーがある場所などは,どこにでもありそうですね。
休日に家族とレジャーを楽しんでいるところではあまり見たくないですね…(!)

マニュアルはだれが読む?(who)

これは大きく2つの立場で考えることができると思います。

  • 情報システムを使っている人(顧客)
  • 情報システムを作った人(サプライヤー)

ここでは「情報システムを使っている人」の立場で考えてみましょう。

  • 情報システム管理者
  • 情報システム管理者の元で実際にシステムを使う者(社員,学生)

情報システム管理者は当然情報システムに対する責任を負うことになりますので,情報システムについて書かれたマニュアルを読むことがあるはずです。
少しわかりづらいかもしれませんが,「情報システム管理者の元で実際に情報システムを使う者」というのは会社で言えば「社員」,学校で言えば「学生」などです。

マニュアルはなにを読む?(what)

「なにを読む?」は「どこを読む?」と置き換えてもいいかもしれません。つまり,マニュアルを開いた時にどのページをめくるかということです。良く見そうなところをピックアップしてみましょう。

  • システムの起動方法と停止方法(停電対応時など)
  • ネットワーク構成(導通確認時など)
  • ソフトウェアのバージョン(ソフトウェアのバージョンアップ時など)
  • 障害時の連絡先(保守先がわからない時など)

いずれも,困った時にこれだけは書かれていないと困るというところばかりですね。

マニュアルはなんのために読む?(why)

これは様々なシチュエーションが考えられます。「いつ読む?(when)」と共通している部分が多いと思いますが,やはり「誰かに行動を起こさせるため」でしょう。

マニュアルはどうやって読む?(how)

マニュアルは一般的には文書でまとめられていることがほとんどですので,マニュアルを読む方法には以下の2種類が考えられます。

  • 紙媒体
  • 電子媒体

一般的には,いつでも誰でも参照できるように紙媒体で置いておくことがほとんどでしょう。最近ではタブレット端末がかなり普及していますので,iPad等にPDF化したものを保存しておくという方法も検索がしやすくて便利かもしれません。

 

この結果から,情報システムマニュアルに必要な機能を具体的な状況下で考えてみると,「情報システムを管理または使っている人が,社内で(自分のデスクで),困ったときに,紙またはIT機器で,誰かに行動を起こさせるための情報ソースとして提示する時に使える」ということになります。

アミュレットの考える情報システムマニュアルのあり方

これまでも見てきたように,情報システムマニュアルは「誰かに行動を起こさせる時に使う」ことになりますので,「日常の業務で役に立ち,必要な時にサッと読めること」が大切です。
各機能の役割は何なのか(各サーバの役割),各部分がどういう仕組みで動いているか(ネットワーク構成,ハードウェア構成,ソフトウェア構成),ちゃんと動く状態にあるのか(障害監視),困った時にはどこに連絡すればいいのか(保守連絡先)などを明記しておく必要があります。

そして,内容が変わった時には,どこがどう変わったのかを「改訂履歴」として残しておくと,情報システムの歴史を知ることもできます。

このようなできるだけ簡素で要点を押さえたマニュアルを整備することで,読者やシステムのユーザとのコミュニケーションが取りやすくなり、関係も良好になることでしょう。試しに、マニュアルを作ってみました(決して「この形式が正しい」ということを示すものではありません,あくまで一例とお考え下さい)。

 

 

アミュレットでは,システム構築業務を承っています

弊社法人営業部では,オンプレミス(自社運用)・クラウド環境に関わらず,情報システムのインフラ構築サービスを提供しています。
https://www.amulet.co.jp/solutions/index.html

構築サービスの一環として、システム運用マニュアルを作成してお届けしておりますが、マニュアル作成にあたっては、システムの目的や使われ方によって記述を修正し、より使いやすいものを目指しています。

最後まで読んでいただいてありがとうございました。
今回提示したシステムは、2017年1月30日から2月10日まで、アミュレット店頭で展示します。また、マニュアル作りのご相談も承っておりますので、お気軽にお問合せ下さい。

お問い合わせ
https://ssl.amulet.co.jp/solutions/contact.html

保存

保存

保存

保存

保存

保存

保存

保存

保存

保存

保存

保存