このサイトは新しいサーバに引っ越しました!!

引っ越し先↓↓↓↓

新便所の穴ブログ:
http://talkingnonsense.coolk2.com/





【ブログパーツ型オンライン予約システム「PORC」】ならインターネット予約があなたのホープページに簡単に導入できます。これで営業機会を逃しません!!美容室や語学学校、法律相談、医院などの業種に最適です。
powered by coolk2.com
【タスク管理システム「BEEF」】は5~10人程度のチームを運営するのに最適なタスク管理型のプロジェクト管理ツールです。これでデスマーチを回避できるかも!?!?
powered by coolk2.com


スポンサーサイト
上記の広告は1ヶ月以上更新のないブログに表示されています。
新しい記事を書く事で広告が消せます。
使われるマニュアルを作る為に気を付ける事
普段、システムの操作マニュアルやら、

運用マニュアルやら、マニュアルと名のつく資料を

作る機会が多いんだよね。

んで、プログラミングもろくにできず、

プロジェクト管理が得意なわけでもなく、

ちゃんとしたテストもできない、

ダメダメなSEなわけですが、

一つだけお客様にお褒めいただいたことがある。

それが、マニュアル作り。

そこで、俺がいつも気を付けていることを

ツラツラと書き出してみる。



※もっとわかりやすく書けねぇのか?ってツッコミは無しで・・・



-------------------------------------------------
【薄く作る】

 まず、よくあるのが、
 「はぁ?これがマニュアル?仕様・設計書の間違いじゃねぇの?」
 って感じのぶっといマニュアル。
 これを平気でエンドユーザーに渡してる場合がある。
 はっきり言って読む気しないでしょ?
 ITリテラシのない利用者はここでまず拒否反応がでる。
 ってか俺も嫌だ、そんなの。よみたくねぇ。
 
 だから、薄く作る!!
 
 その為には、読み手を絞らなきゃいけない。
 ITリテラシのない一般利用者向けなのか、
 知識がある程度知識あって、
 より効率的に使いたいヘビーユーザーなのか、
 システム知識がある程度あるシステム管理者向けなのか、
 もしくは、システム管理者になろうとしている準管理者なのか、
 それによって、冊子を分ける。
 
 また、本当に必要な事だけ書き、
 余計なことを書かないようにする。
 それによって、薄くなる。

 よくある例は、
 「こういう方法で操作するんだけど、
 こういう便利な方法がありますよ~」とか
 書いてある所は間違いなく
 ITリテラシのない一般利用者は混乱する。
 書きたい気持ちはわかるよ。
 作った本人からすればね。お勧めしたいもの。
 でもそれは書かない。
 そういう所は使いながら気づいてもらう。
 もしくは別のマニュアルや冊子に書く。

 書くべきは、
 「これをすれば間違いなく目的の結果が出る」
 の一点のみ。
 
 「何冊もマニュアル作るのメンドクサイ」だって?
 まずやってみれ。
 1冊にまとめるよか、作成時間がはるかに早いし、
 その後のメンテナンスが楽チンだから。



【ツールとしてのマニュアル】

 な~んか勘違いしてマニュアル作ってる人が多いんだよね。
 マニュアルは読み手を楽しませる小説じゃないのよ?
 ボク~わかってまちゅか~?

 つまり、マニュアルを読み物として作るなってことだ。
 マニュアルはシステムだったり機械だったりを
 上手に動かすためのツールなのよ。

 もしアンタが何かのシステムやソフトを使う利用者だとして
 マニュアルを手に取る時はどんなときだ?

 二つの状況が想定できるはずだ。
 それは「操作がわからなくなってマニュアルを見る」と
 「使う前の勉強の為にマニュアルを流し見る」ってことだ。

 はっきり言って、これ以外でマニュアルを見ることは皆無。
 つまり、小説を読むみたいに初めから、
 一字一句読んでくれるユーザーなんて居ないのよ。

 ってかさ、家電を買って、取扱説明書を1ページ目から
 読むやついるかい?
 おれは読んだことがない。ほとんどの人がそうだろ?

 どこから読まれても、流し読みされても、
 ユーザーに内容を伝えられる様に書くべきなんだよ。
 逆を言ってしまえば、わかりやすければ良いので、
 一字一句きれいな日本語の文章にする必要はない。
 極端に言えば、文書である必要さえないと思ってる。

 この現実から具体的に何をすれば良いのかというと、
 「目次と索引の構成に一番気を使え」
 「どこから読んでもわかるように書け」
 ってことだ。



【図の盲点】

 「見やすくわかりやすいドキュメントにする為には図を使え」
 って良く言われるよな?
 でもな、闇雲に図や絵を使えばわかりやすくなるってもんでもない。
 
 良くあるのが、アプリケーションやシステムの相関図みたいのが
 マニュアルに載ってるんだけど、
 「オマエには大事かもしれんが、俺には関係ねぇ!!」
 っと言いたくなる図がたくさんのってる。
 また「この図はどこから見ればいいんでつか?」とか
 「この図で何が説明したいのかわからん・・・・」って図が
 のってるやつ。経験あるでしょ?
 
 そもそも、言いたいことを図に表すのは、
 文章を書くよりもずっと難しい。
 文章だったら、伝えたい内容を表す日本語の文章は、
 読み手がどんな人間であれ、単語にさえ気をつければ、
 文章の構成はおのずと決まってくる。
 だけど、図ってやつは、人それぞれ図を見て
 受け取る内容が異なってくる。
 なぜなら、人には感性ってもんがあるからだ。
 それを無闇やたらに多用してみろ。
 わけわからんくなるのも無理はない。
 
 「そんなら、どうすればいいだよ?」って?
 そんなの俺に聞くな!!
 おれもわからんわいwww
 ってかそんなのに定石なんてあるわけないがな。
 自分で考えろヴォケ!!
 
 ただ、一つ言えるのは、良く考えて図を使えってこと。
 良く考えずに図を使うと逆効果になるぞってことだ。

-------------------------------------------------
関連記事


テーマ:仕事の現場 - ジャンル:ビジネス
2008/12/26(金) 16:18:09| 仕事の事| トラックバック:0 コメント:0
コメント
この記事へのコメント
コメントを投稿する
URL:
Comment:
Pass:
秘密: 管理者にだけ表示を許可する
 
トラックバック
この記事のトラックバックURL
この記事へのトラックバック
上記広告は1ヶ月以上更新のないブログに表示されています。新しい記事を書くことで広告を消せます。