資料館/ReadMeTXT - パソコン忘備録

パソコン忘備録 > 資料館 > ReadMeTXT

ReadMe.txtに書くべき内容

ReadMeというだけあり、利用者に見てもらいたい読んでもらいたい内容を書く添付書類だ。
ReadMe.txtの書式は大手メーカーであっても企業によって書き方は様々。つまりコレといった
決まった書式があるわけではない。

ここで記すのは自作ソフトやアプリを世（AppStoreやGooglePlay等）に出すとき、書いておいたほうが
後々いいよ、ということを書き残す。

もちろん下記のフォーマットは絶対でも必須でもない。好きな書き方をしていい。

• バージョンとリビジョンは、いずれか一方で良いと思う。
• ビルド番号は、出してもいいなら書いておいたほうが開発者や問合せ担当で切り分けが楽になるだろう。
• 作成者、作成日は必須。作成者は本名でなくとも団体名、会社名で構わない。
• 最も必要だと思う部分「ライセンス」。フリーソフトなら"GPL"か"CC"にすることが多いと思うが、

　CCの場合は表示、継承、改変などのプロパティを明記しておくことを忘れずに。

• サポート窓口は使い方やFAQをまとめた告知ページ、サイトから文章で問合せるためのフォームページ、

　メールで直接問合せられるメールアドレスを書いておけばいいだろう。但し３つとも必須ではない。

//////////*//////////*//////////*//////////*//////////
アプリケーション名
バージョン
リビジョン
ビルドナンバー
作成者（又は作成団体名、会社名）
作成日

ライセンス

サポートサイトURL
サポートフォームURL
サポートメールアドレス
//////////*//////////*//////////*//////////*//////////

例）
//////////*//////////*//////////*//////////*//////////
Androidマイカレンダー
ver.1.0
rev.100
build.020
Auther is k-plus

License: Creative Commons [CC BY-SA]

Support
 http://www.example.com/support/
 http://www.example.com/support/mailform/
 [e-mail]

Thank you.
//////////*//////////*//////////*//////////*//////////

上記は表題部分の書き方で、表題（文頭）以下は、もちろんソフト・アプリの使い方を書く。
書き方は自由だが、ユーザが行なうであろう手順を時系列に沿って書くことが好ましい。

１．ソフトの目的
２．インストール方法
３．基本的な操作方法
４．アンインストール方法
５．FAQ

といった具合だ。
ソフトの目的は、絵が掛ける、音楽を再生できる・・といった内容。概要といっていい。
インストール方法は、インストーラー任せでいいように作ると思うが、たとえばファイルの
初期保存先の設定画面があるなら、デフォルト設定の変更方法を書いておくといいだろう。
基本的な操作方法は、ソフト・アプリの起動方法、ファイルの指定方法、実行や再生方法と
いったものだ。
アンインストール方法も、基本的にアンインストーラーから削除するものが殆どだと思うが、
フォルダが残ってしまう場合やレジストリを削除することが必要なら合わせて書いておくのが
いいだろう。
FAQは、自分が思いつくことだけ書いておけばいい。ソフト・アプリの使い方なんて人夫々で
リリース後に届くユーザーからの問合せを受けて追記する形になってしまうはずだ。

再三再四になってしまうが、必ず「ライセンス」については明記することだ。
これが書かれていないと、コピーレフト（権利放棄）と勝手に解釈され、自分の知らないところ
で勝手に利用されてしまう可能性がある。
性善説で考えることは悪いことではないが、性悪説的に考えておいたほうが無難だ。