ヘルプを書くトップ / ソフト・ゲームを作るには
/ ヘルプを書く
ヘルプを書くソフトを買った時、ダウンロードした時、 普通はまず始めに「ヘルプ」や「ReadMe」を見て操作方法を調べると思います。 その操作方法の書き方をヘルプの書き方とともに一つの方法を紹介しようと思います。
ヘルプファイルの種類ヘルプを書くためには、ヘルプ用のファイルを作る必要があります。 一番簡単なのは、TXTファイルなどのテキストファイルです。 Windowsのメモ帳などで書けるので、簡単に書くことができます。 次に、HTMLを使ってヘルプを書くことが出来ます。 ホームページを持っている人にはお馴染みだと思います。 テキストと違って、レイアウトを組むことが出来ます。 (ワードの文章はワードを持っていないと見られない可能性があるのでやめた方がいいです。) WINヘルプなどのヘルプ用のファイル形式もあります。ただし、作るのに専用のソフトが必要です。 ヘルプの内容まず、ヘルプに書くべき内容をまとめてみます。 |
| ソフトの名称 | ソフトの名前 |
| バージョン | ソフトのバージョン |
| 作者 | ソフトの製作者 |
| 概要 | ソフトの簡単な説明。分かりやすい説明があると、今後の説明がしやすい。 |
| 動作環境 | OS(ウィンドウズ・LINUXなど)と
そのバージョン(98,XPなど) また、ランタイムライブラリが必要な場合もそのことを書く |
| ソフトの説明 | ソフトの細かい説明。 |
| 操作の説明 | キーボードやマウスなどの使い方。 「方向キー で 移動」など (なお、キーボードの説明をするには素材の 「キーボード」が便利！) |
| 画面の見方 | 実際のウィンドウのスクリーンショットを利用すると、 利用者が全体像をつかみやすくなります。 |
| メニュー | メニュー(ウィンドウの上方に出ている「ファイル」・「編集」など)がある場合極力書く。 書かないと、利用者がメニューをほとんど使えなくなる可能性がある。 |
| 更新履歴 | ソフトによっては利用者がアップデートするかの判断材料になります。 |
| 謝辞 | 他の人の作った素材を利用した時は必ず書きましょう。 |
| 連絡先 | メールアドレスやホームページアドレス。できるだけ明記しましょう。 |
| Ｑ＆Ａ | すでにいろいろな質問が来ている場合は、書いた方が親切かもしれません。 |
ポイントを押さえるここでは、ポイントごとにまとめてみようと思います。 最初に書くこと1. タイトル ヘルプの最初には、ヘルプのタイトルと共に、 「タイトル」「バージョン」「作者」などの基本的な情報を書きましょう。 メールアドレスなどの連絡先を最初に書いてもいいと思います。 例) 〜 七ならべ 〜 Ver 2.4 作者 Green 2. 簡単な説明 また、ソフトで何ができるかの説明や、セールスポイントや強みなど、 ソフトの簡単な説明を書いておくといいと思います。新機能などを書いてもいいでしょう。 例) 3. 目次 ヘルプが何ページかある場合は、目次を出しましょう。 1ページしかない場合でも、ページ内の目次があると便利です。 |
ソフトの説明ソフトの説明をするというのは、以外に難しいものです。ここで、その説明方法を見ていきましょう。 1. 簡単な説明 これは、「最初に書くこと」の2つめと同じです。一番初めの紹介と全く同じ文章を書いてもいいと思います。 最初の文章よりも掘り下げて書くと効果的。 2. 操作の説明 キーボードやマウスに対する基本的な操作の説明です。ソフト全体に対する操作だけでいいです。 特殊な操作がある場合は、個別に書いたほうがいいと思います。 例) あるいは 例) 見やすいと思うほうを選んでください。 なお、マウスとキーボードは空白行を入れるなどして区別した方がいいです。 3. 基本的な機能の説明 大きなソフトになってくると、機能の数も多くなってくると思います。 その場合は、まず、最低限必要な機能に絞って説明するといいと思います。 必ず必要なこと(起動・終了など)や頻繁に使う操作をまとめておきましょう。 4. メニュー ウィンドウの上部にメニューを表示している場合は、メニューの説明をすると利用者に分かりやすくなります。 5. すべての機能の説明 あたり前のことですが、あなたが作ったソフトは、基本的にあなたしか正しい使い方は分からないものだと思います。 基本的には、すべての機能について触れるようにしましょう。 |
最後に書くこと1. 連絡先 ホームページアドレス、メールアドレスなどの連絡先です。 そのソフトを気に入ってくれた人は、もしかすると、 バージョンアップした時にまたダウンロードしてくれるかもしれません。 そんな人が頼りにするのは連絡先です。 また、バグや要望を送ってくれるかもしれません。 2. 謝辞 素材などを使った場合などは必ず書きましょう。 基本的には、お世話になった人(ハンドルネーム)とホームページのアドレスを書くといいと思います。 |
最後に分かりやすいヘルプ実際に書き始めると、ヘルプを書くのが意外と難しいと思うかもしれません。 いろいろな表現を試してみてください。 実は、大切なことは分かりやすいソフトを作ることです。 分かりやすいソフトを作ることで、ソフトが使いやすいだけでなく、 ヘルプも書きやすくて読みやすくなります。 文章の書き方を勉強するあとは、実際に文章を書くことができれば、ヘルプを書くことができます。 私は作文が下手なので、あまり役に立つことは言えません。 文章を書のに、「5W1H」や「起承転結」あるいは、 手紙や文章の書き方などが参考になると思います。 また、ホームページの製作の仕方を学ぶと文章の書き方＋HTML の勉強になって一石二鳥です。 最後にもちろん、これらはヘルプの書き方ほんの一例です。 さらに自分のアイデアを足すと、ヘルプだけでも面白いものができるかもしれません (しできないかもしれません)。 分かりやすいヘルプを書くようにしましょう。
トップ / ソフト・ゲームを作るには
/ ヘルプを書く
2006/8/3 更新 |
