6.READMEの作り方

6.1.HTMLでREADMEを作る
6.2.1ページのものにもREADMEをつける
6.3.対象ブラウザを表記する
6.4.README例文

 READMEってなんでしょう?そう、よくゲームのCD-ROMにはいってたり、フリーウェアやシェアウェアを解凍したときに一緒にでてきたりする、あの説明文です。個人WEBサイトで公開されているゲームの攻略法にはついていることは少ないのですが、niftyではライブラリにアップするときに説明文を一緒にアップしなければならないため、きちんとしたものが作られています。この説明でよくわからない場合は、実際の例を見てもらった方が早いと思いますので、こちら(『6.4.README例文』)をご覧ください。

 READMEが嫌であれば「著作権ポリシー」などの形で文書についての説明をしてもかまいません。とにかく何らかの形でそういったことを表記しておいた方がよいだろうということです。

6.1.【HTMLでREADMEを作る】

 なんのことはありません。HTMLで攻略法を作った場合はHTMLでREADMEを作ってリンクを張った方が、使う側が見る機会も多くなりますし、統一性があってよいというだけの話です。攻略法のタイトルロゴなんかを作った日には、そのタイトルロゴをクリックするとREADMEに飛ぶなんていうのも遊び心があってよろしいかと思います。

6.2.【1ページのものにもREADMEをつける】

 上の項目とも関係してきますが、HTMLで1ページのみの攻略法の場合も、最後にREADMEをつけた方がよいだろうということです。1ファイルのみではTEXTファイルの添付ができないという問題点が解消されるだけでなく、利用者がREADMEを見る回数が増えるという利点もあります。(『Moe攻略法HTML版』参照)

6.3.【対応ソフトを表記する】

 HTMLで書いたのなら対応ブラウザを、その他のソフトで作ったのならどのソフトで作ったのかを書いておきましょう。

 HTMLで作ったときは対応ブラウザ以外で見られることを意識して、READMEをTEXTファイルで作る、あるいはCSSなどを使用しないようにするのがよいでしょう。読めないREADMEに「読めません」と書いてあっても意味がないですから。その際には以下のように「◎」「○」「△」「X」などの記号と説明を書いておくとわかりやすくてよいかと思います。

記号 説明文 具体的な説明
(ほぼ作者の意図したとおりに表示) 完全に意図どおり、もしくはちょっと意図とは違うというくらいの場合。
(閲覧には支障ありません) CSSが無効になっている場合やいらないスペースが入っている場合などです。
(使用は困難です) ほとんど崩れているが一部が判別可能である場合などです。実際には実用に耐えないものと思われます。
× (御覧になれません) 判別が絶対できない場合。

 また個人WEBサイトで攻略法を作っている場合、READMEも一覧リストからすぐに見られるようにしておけば、利用者は使いやすいでしょう。

6.4.【README例文】

 こういうのはほとんど定形文なので、下の例文をコピーして付け加えたり削除したりして仕上げたりするといいでしょう。下の文は自由に改変して使用してもらってかまいません。著作権フリーの例文と考えてください。HTMLでREADMEを作る際にはこの『攻略法の作り方』のREADMEを参考にしてください。

======================================================================
【データ名】Moe-萌黄色の街-攻略チャートHTML版
【登 録 名】Moe.htm 【moe】攻略チャートHTML版
【検索キー】1:攻略, 2:Moe 3:萌黄色の街 4:ユニゾンシフト
【著作権者】KO-1(DZR05634)
【作成協力】攻略プロジェクトルーム有志
【動作環境】HTMLファイルの読める環境。
    CSS対応ブラウザを推奨。
【転載条件】作者に連絡ください
======================================================================

【チャート紹介】
・メインヒロイン6人+αの攻略法
・CG及び"ひみつメモ"コメント欄の出し方を網羅

 基本的にこのゲーム、オンリープレイで追っかけをやってれば大抵クリアで
きます。そういうわけであんまり難易度は高くないんですが、かといって正解
の選択肢を探したり力技でクリアしたりするのは軽妙なギャグの掛け合いのテ
ンポを崩してしまって面白くなくなるので作ってみました。

※このチャートは元々テキストファイルで作成されたものをHTMLに再編集した
ものです。HTML向けに再編集したところはありますが、攻略法自体は基本的に
テキストファイル版と変わりません。

【使用方法】
 このファイルはHTMLファイルです。Moe.htmという名前でダウンロードして
いただければ、ダウンロード後すぐに御覧になれます。
 またこの攻略法はCSSを使用しています。CSSに対応したブラウザ(下記表示
確認済みブラウザで◎のもの)で見ることを推奨します。

【表示確認】
《ブラウザ名》      《言語/OS》《表示》
Netscape6         ja/Win  ◎(ほぼ作者の意図した通りに表示)
Netscape Communicator4.73 ja/Win  ◎(ほぼ作者の意図した通りに表示)
Netscape Navigator3.01   ja/Win  ○(閲覧には支障ありません)
Internet Explorer5.5    ja/Win  ◎(ほぼ作者の意図した通りに表示)
Internet Explorer3.0    ja/Win  ×(御覧になれません)
 このファイルは以上のブラウザにて表示確認をしています。

【免責事項】
 出来るだけのことをして検証を進めたつもりですが、解析まではやっていな
いので万全というわけではありません。従って、間違い等があるかもしれませ
んが、その際は誠に勝手ながら作者は一切の責任を負わないものとさせていた
だきます。ご了承下さい。

【その他】
 この攻略チャートはKenさん(QWS05104)のパティオ『攻略プロジェクト
ルーム(パスワード未設定)』で検証して貰いました。場所を提供してくれたK
enさん、そしていっしょに検証してくれた全ての人たちにこの場を借りて感
謝いたします。

・何かご意見ご感想があればKO-1(myu-myu-myu@nifty.com)までメールしていた
だくか、あるいは上記パティオでの発言という形でお願いします。

                     2000年12月某日 DZR05634 KO-1


#この定型文はniftyへライブラリ登録する際に使う形式なので、ヘッダ部分など、WEB用に作る際には必要のない項目が含まれている。とはいえ、まだフリーソフトでもこういった形式でREADMEを書いている人もいることと、また一部必要のない項目が含まれているものの合理的にできている、ということから定型文としてこれを採用することにした。

 インターネットでしか公開しない場合に特に必要のない項目はヘッダ部分の【登録名】と【検索キー】だろう。本文においては特別なソフトを必要としないかぎり【使用方法】は必要ない場合が多いと思われる。

 もちろんこれが絶対唯一のREADMEの書き方というわけではないので、自分なりに利用者から見て読みやすいREADMEを追求してほしい。

<<戻る<< ▲TOP▲ ■フレーム化■
 >>次へ>> ■INDEX■ サイトマップ/索引/略語用語集
KO-1(myu-myu-myu@nifty.com)