「取説屋:石井ライティング事務所」の代表兼テクニカルライターのブログ 本家サイト http://torisetuya.com

【わかりやすいマニュアルの作り方】 第47回 基本操作について(Software) その09

今回も前回同様、第44回の内容の説明です。
今回は一日更新が遅れてしまいました。
申し訳ありません。

さて。

今回で、この項目の説明は終了になりますが、書き落としたことなどを追記します。
さらっと述べて触れなかったり、操作グループの名称についてです。
ここでは、以下のようなものがあります。

2)「印刷の向き」欄

3)「ページの順序」欄

選択肢の1セットの場合もありますが、「用紙・印刷の向き」のように複数の項目が1セットになっている場合もあります。
私たちのところでは、こういった枠で囲われた入力項目の名称を「●●欄」と統一しています。

また別のところで書く機会があるかもしれませんが、こういった用語の統一はとても大切です。「印刷の向き」だけを書いていると、「プレビュー」で表示されている内容なのか、入力項目なのかがわかりにくくなる場合があるためです。

また、入力項目が多く、たいへんゴチャゴチャした画面の場合は、画面上の「論理的な」入力項目のセットをさして「●●入力エリア」と名付けて記載する場合もあります。

こうした場合は、画面の一部を切り抜くか、枠(赤などにしたいけれども、大概のマニュアルはモノクロ印刷だったりします)をつけて、名称をわかるように付加します。

これで、とりあえず、今回の説明はいったん終わりです。
次回からは、また別のシリーズになります。

ネタを考えないと…


【わかりやすいマニュアルの作り方】 第46回 基本操作について(Software) その08

今回も前回同様、第44回の内容の説明です。

1)レイアウトタブ

現在の設定項目を表示します。
一見不要な説明に見えますが、操作項目を説明する場合には他の画面(この場合は「用紙/品質」タブ)に移動したときにも同じものを書くため、この項目がないとかえって不自然な感じを与えます。

2)「印刷の向き」欄

印刷の方向を選択します。

3)「ページの順序」欄

印刷する順番を選択します。

4)シートごとのページ

印刷するページ数を選択します。

(2)~(3)は操作の目的は異なりますが、同じラジオボタンの操作です。
(4)はスピンボックスの操作です。
しかし、これらの操作はすべて用意された選択肢から選ぶもののため、統一して「選びます」としています。
これが入力ボックスであれば、「入力します」と書きます。
ここでのポイントは「ラジオボタンをクリックします」とか「クリックしてリストから選択します」とか「書かない」ことです。
そういいったことは、Windowsの標準UIの操作であり、ソフト固有の操作ではないため、わざわざ書かない方がスッキリしますし、また仕様変更にも強いという裏の意味もあります。

5)「用紙/品質」タブ

「用紙/品質」の設定画面を表示します。

6)「詳細設定」ボタン

「詳細設定」の画面を表示します。

(5)と(6)は画面遷移の操作です。
遷移先の画面名を確実に記載することがポイントです。

続きます。


【わかりやすいマニュアルの作り方】 第45回 基本操作について(Software) その07

「わかりやすいマニュアル」以外のエントリが2回続きました。
ということでここらでまた毎週1回のエントリに戻ります。
前回(44回)の内容の説明です。

●画面の見方

右側の「プレビュー」は設定内容を表示します。
入力が終了したら「OKボタン」をクリックします。
入力をやめるときは「キャンセルボタン」をクリックします。

この部分は全体の説明です。
まず、操作を行わない「プレビュー」の部分を説明しています。

ここで、さらっと「プレビュー」と書いていますが、実はこの「プレビュー」という名前による定義づけ(「画面の横の方にある、印刷結果を見せるヤツ……」とかでなく)が必要なため、ここで文章を書く必要はないにもかかわらず、あえて書いています。

もちろん、画面の説明にも吹き出しで「プレビュー」と表示してあります。

「OKボタン」と「キャンセルボタン」は、僕の場合、一番最初に書くことにしています。この操作は、「この画面を終了する」ときに必要だからです。

「起動方法と終了方法」は1番最初に書いておく。

これはとても大切なことです。

以下続きます。


【わかりやすいマニュアルの作り方】 第44回 基本操作について(Software) その06

前回はプロパティ画面の内容・要素を列挙しました。
内容は以下の通りでした。

「プロパティ」画面「レイアウト」タブ

この画面には以下の項目があります。

1)「印刷の向き」欄

「縦」「横」「横向きに回転」の「ラジオボタン」があります。

2)「ページの順序」欄

「順」「逆」の「ラジオボタン」があります。

3)シートごとのページ

ページ数を選ぶ「スピンボックス」があります。

4)プレビュー

印刷の向きのプレビューが表示されます。

5)「詳細設定」ボタン

6)「OK」ボタン、「キャンセル」ボタン

7)「用紙/品質」タブ

8)「?」「×」ボタン

今回はサンプルとして、実際に画面説明をする場合の画面を掲載します。

ji(3.:exe94k

マニュアル掲載用の画面

こんな感じになると思います(実際には1番の「レイアウト」タブは不要かもしれません)

それぞれに対して、以下のような説明文が着きます。

画面の見方

右側の「プレビュー」は設定内容を表示します。
入力が終了したら「OKボタン」をクリックします。
入力をやめるときは「キャンセルボタン」をクリックします。

1)レイアウトタブ

現在の設定項目を表示します。

2)「印刷の向き」欄

印刷の方向を選択します。

3)「ページの順序」欄

印刷する順番を選択します。

4)シートごとのページ

印刷するページ数を選択します。

5)「用紙/品質」タブ

「用紙/品質」の設定画面を表示します。

6)「詳細設定」ボタン

「詳細設定」の画面を表示します。

おわかりでしょうか。
Windowsのシステムに従った書き方で列挙したものとは、内容が大きく異なっています。
つまり、説明とは、内容の列挙とはまったく異なったことということです。
詳しい内容の説明は次回から行います。


【わかりやすいマニュアルの作り方】 第43回 基本操作について(Software) その05

今回は長めなのであまり横道にそれずに、すぐ本題に入ります。

画面の名前の定義

前回はそれぞれの画面に名前を定義しました。

  • 「プロパティ」画面「レイアウト」タブ
  • 「プロパティ」画面「用紙/品質」タブ
  • 「詳細オプション」画面

こういった画面の名称はマニュアルの初出時に定義して、同一のマニュアル中では決して名称を変更しないことが必要です。

たとえば「プロパティ」画面の「レイアウト」タブという名称を「レイアウト」タブと略すのは同じ節の中で一度定義されているなら許されますが、「レイアウト」画面などと書くことは間違いです。

ハードウェアのところでも書きましたが、マニュアルはメーカーとお客様の間をつなぐものです。ここで定義が曖昧だと、お客様がサポートに問い合わせたときに混乱する元となります。

画面にある項目を、Windowsのシステムに従った書き方で列挙してみます。

画面内の項目について

「プロパティ」画面「レイアウト」タブ

MFP-XC7000 プロパティ レイアウトタブ

MFP-XC7000 プロパティ レイアウトタブ

この画面には以下の項目があります。
・「印刷の向き」欄

「縦」「横」「横向きに回転」の「ラジオボタン」があります。

・「ページの順序」欄

「順」「逆」の「ラジオボタン」があります。

・シートごとのページ

ページ数を選ぶ「スピンボックス」があります。

・プレビュー

印刷の向きのプレビューが表示されます。

・「詳細設定」ボタン

・「OK」ボタン、「キャンセル」ボタン

・「用紙/品質」タブ

・「?」「×」ボタン

たったこれだけの画面なのに、説明にすると意外と多いと思いませんか?
次回は「ラジオボタン」「スピンボックス」「ボタン」の記述について書きます。

続きます。


【わかりやすいマニュアルの作り方】 第42回 基本操作について(Software) その04

今回からは、基本操作のソフトウェア編です。

ソフトウェアの基本操作

さて。
定義にどのように書いたかのおさらいからです。

Windowsのソフトウェアの場合は操作が統一されているため「画面の見方」や「○○画面の操作」といった項目になります。
「基本操作」は、状況によらないすべての画面や、機器操作の手順でなど操作について記載します。

今回は、サイトにアップロードしてあるサンプルでも使用している「実在しない」プリンタ「MFP-XC7000」を使って説明します。
それぞれの画面は以下のように名前を定義します。

「プロパティ」画面「レイアウト」タブ

MFP-XC7000 プロパティ レイアウトタブ

MFP-XC7000 プロパティ レイアウトタブ

「プロパティ」画面「用紙/品質」タブ

MFP-XC7000 プロパティ 用紙/品質タブ

MFP-XC7000 プロパティ 用紙/品質タブ

「詳細オプション」画面

MFP-XC7000 プロパティ 詳細オプション

MFP-XC7000 プロパティ 詳細オプション

これらの画面は「印刷」画面から「詳細設定」ボタンをクリックすることで呼び出されます。

印刷画面

印刷画面

次回より、説明本文に入ります。
展開が遅くて申し訳ありません。

続きます。


良い製品に良い取説を提供します is powered by Wordpress | WordPress Themes