システムの操作マニュアルのあるべき姿と作り方

システムの操作マニュアルのあるべき姿と作り方

やっとではありますが、昨日から自作システムのマニュアル作りを始めました。

『動く道具作ってもマニュアルなきゃ売り物にならないしね』
と言う事で「どんな形がベストか」いろいろ思案したんですけど、これが結構難しい。
いや、結構どころかすごく難しい…。

素敵な使い易いマニュアル作れる方、超尊敬します。
と言う事で、マニュアル作成に向き合い感じた事を備忘録としてそのまま記載しようと思います。

作成者がマニュアルを作らない方が良い？

うん、超実感しました。

私の場合は自分で全てこなさないといけないのでマニュアルも私が作ります。
が、作成者のマニュアル作成には２つのネックがあると気づかされました。

少しまとめたものを見返してみると「(私は理解するけど）はじめてツール使う人は無理だろうなぁ」と…。
可能な方は打ち合わせしながら第三者にまとめてもらうのが良いと思います。

1.思いが強いマニュアルは説明がゴチャゴチャして解り難い

昨日は書いていて収集が付かない状態でした。下書きの段階からゴチャゴチャ感が半端ない。
簡単なツールなら良いのでしょうけど、EC出品ツールのような『アレのコレがココと連動して』なんて道具は細かく書きだすとあっちこっちに飛ぶ飛ぶ。

結果下書きでとんでもない時間を消費しています。

ゴチャゴチャする原因は場合分けの多さです。

同じ結果を作りたくてもシステム操作自体には様々なルートが確保されています。

判り易くテレビのリモコンの例で確認してみます。
現在のチャンネルが４で１を映したい場合

これをマニュアルに書き出すと…初見の人は「で、何すればいいの？」となるわけです。
んで、これを書き出してしまう…ダメですねぇ。

2.作成者は【最初に何するか】が明確になってない

今回色々まとめていたらポロっと抜けていた仕組みが顕在化しました。

それは、楽天市場の出品データから初期値の商品DBを作成するという機能。

その為のDBスペースは作成してあるんですけど、自分が作りながら検証してとなると先に求める機能の実装をします。今回のシステムの場合は【モールに出品する】という機能です。

この機能の実装の為には初期データが入っていないといけないので、SQLに直打ちしたりして初期DBを登録画面を介さずに登録してしまいます。

こんな事が重なっているので『最初にどうすれば簡単にDBを蓄積できるのか』が明確になっていません。

結果、こちらもゴチャゴチャしてきます。

良いマニュアルとは

私が今理解してることはこんなところ。きっとまだまだ要件はあるのだと思います。

実際にどう実装するか

最低限必要なのは３つの導線だと思います。

これを構成するためには、マニュアルDBが必要になります。検索できるようにしなきゃ出しね。
文字を直接書いてページ作っちゃダメです。
だからマニュアルPDF作ろうなんて考えちゃダメです。あれ実際『実用的』じゃないでしょ？

私はこんな感じでテーブルをまとめました。

どう分類分けをするかは其々の仕組みで異なるとは思いますが、こんな感じでテーブルを実装すると記事に合わせたDBの抽出が容易になると思います。テーブル数増やしたくなければ分類は記号としてのナンバーだけでもOKですよね。

DBが出来たら記事を抽出して表示させるだけだから更新も楽っ♪

どのページで何を表示させるかはコントロールしなくてはいけませんが、目的の記事を抽出して順番に表示させればとりあえずのマニュアルが完成します。

あとはより見やすく画面の構成見直したり画像の入れ方考えたり。ページデザインのお仕事です。

並び順の項目を用意しておくと、この調整だけで上下の入れ替えが完結するのでとても便利だと思います。

まとめ

いやぁ～
『マニュアル作り』正直なめてました。
ここまで大変になるとは…。

でもこれ終わらないとシステムが商品にならないんですよね。
がんばろ。