3

私は自分のプロジェクトを文書化して整理する方法に夢中になっています。readme ファイルのベスト プラクティスに興味があり、そこに何が含まれているべきかについてもっと知りたいと思っています。主にレールを使用しています。しかし、私は、readme は読者を想定してはならず、すべてをゼロから説明するべきだと考えています。では、Web アプリケーション プロジェクト用の理想的な、時代を超越した説明的な readme ファイルは何でしょうか? また、お好きなreadmeファイルを添付していただけると大変助かります。

コンテンツ？アプリについての短い情報？言語、フレームワーク? スクリーンショット？フォーマット？マークダウンとプレーン？理想的な展開？等..

4

1 に答える 1

0

読者について仮定をしない場合は、プレーン テキストが最適です。マークアップ言語はすべて解析して変換する必要があり、readme をローカルで表示しているときには不可能な場合があります。Github などのサイトはさまざまなマークアップ形式をサポートしていますが、それらがサポートするものに限定されます。

コンテンツの条件: コンパイル、ビルド、実行、変更など、ユーザーが実行する可能性のあるすべてのことを説明する必要があります。

于 2012-06-21T16:30:17.307 に答える