システムのマニュアル

システムのマニュアルを作成する場合、
2つの視点が必要になります。

画面の要素の説明と操作手順の説明です。
なお、画面の要素とは、ボタンの機能であったり、
項目名であったりを示します。

まずは、画面の要素の説明についてです。

画面要素の説明を記述する場合、
キャプチャーした画面の画像を配置し、
その下に、説明を書きます。

画面をキャプチャーする際には、
このようなソフトが便利です。

キャプチャーした画像で、説明したい箇所を、
赤枠で囲います。(ペイントソフト等を使用)

対応関係をはっきりさせるため、キャプチャー画像内に、
番号(①○○ボタン、②ステータスバー、③***、・・・)
と書き込み、その番号に対する説明文とすると良いです。

次に、操作手順を説明する場合、
まず、完成図を示し、その下に、スタートから
完成までを示す手順を示すと良いです。

例えば、料理であれば、出来上がりの写真があって、
材料を調理していって、最後に出来上がりとなるのと
同じです。

ポイントは、大まかな流れを決めたら、
画像を先にキャプチャーしておくことです。

画像の位置や内容によって、説明文は変わることが
多いため、先にキャプチャー画像を用意しておくと、
作業を効率的に進めることができます。

試してみてください。