Readmeの書き方

コンテンツ

ステップ
チップ
あなたは何が必要ですか

Readmeファイルは、通常プログラムに含まれている小さなドキュメントです。 Readmeファイルはソフトウェア開発者によって作成され、インストール情報やシステム設定のガイド、連絡先情報、ライセンス、表彰、ソフトウェアバージョン情報などのプログラムに関する基本情報が含まれています。ソフトウェアの配布では、Readmeファイルの書き方を知っておくことが重要です。不十分に書かれたReadmeは、ユーザーにとって苛立たしくて面倒なものになる可能性がありますが、優れたReadmeは、プログラムに関する基本情報を簡単に学ぶのに役立ちます。

ステップ

1 連絡先情報を含めます。 これはおそらくReadmeドキュメントの最も重要な部分です。連絡先情報により、ユーザーは、プログラムの補足、質問、エラーの修正、またはプログラムの支払いを提案するためにあなたに連絡することができます。会社名、ウェブサイト、電子メール、電話番号を含めてください（この情報には数行かかります）。
- 写真に例を示します。
2 日付をReadmeに挿入します。 これは小さいですが、非常に重要なステップです。プログラムの配布日をマークすることが重要です。このようにして、ユーザーはプログラムバージョンの更新を認識し、それがまだサポートされているかどうかを判断することもできます。
3 プログラム名、バージョン、および価格情報をメモします。 上部に、アプリケーション名とバージョン番号を記入します。フルバージョンの価格を以下に記入してください。 CDなどの物理メディアを使用してプログラムを配布する場合、ユーザーがすでにプログラムの料金を支払っている可能性があるため、価格情報を含めない場合があります。
4 プログラムについて簡単に説明してください。 プログラムの簡単な説明を1、2文で入力してください。例：「このアプリケーションは、インターネット上でのユーザーのアクティビティを分析することでユーザーの気分を追跡し、ユーザーの感情状態に適応するようにデスクトップ上のスペースを変更します。」
- ソフトウェアにかなり幅広い機能がある場合は、説明を1〜2段落拡張できます。箇条書きを使用して、プログラムのすべての機能に番号を付けることができます。
5 プログラムの最小要件を説明してください。 優れたReadmeファイルには、プログラムの最小要件とインストール手順に関する情報が含まれている必要があります。プログラムをインストールするために別のソフトウェアが必要な場合は、必ずそのことを伝えてください。推奨要件（CPU負荷など）に関する情報を含めることもできます。
6 ライセンスと著作権の情報を含めます。 最後に、著作権の確立日とプログラムのライセンスに関する情報を含めることを忘れないでください。