エントリーの編集は全ユーザーに共通の機能です。
必ずガイドラインを一読の上ご利用ください。
ここにツイート内容が記載されます https://b.hatena.ne.jp/URLはspanで囲んでください
Twitterで共有ONにすると、次回以降このダイアログを飛ばしてTwitterに遷移します
注目コメント算出アルゴリズムの一部にLINEヤフー株式会社の「建設的コメント順位付けモデルAPI」を使用しています
READMEとは READMEはアプリケーションの 概要 環境構築手順 など、プロジェクトに必要な情報を一通り記... READMEとは READMEはアプリケーションの 概要 環境構築手順 など、プロジェクトに必要な情報を一通り記載しているファイルです 今回はGitHubなどで記載されているわかりやすいREADMEの書き方について解説していきます READMEを書く目的とは プロジェクト内に新しいメンバーが入った時にプロジェクトの概要や必要なドキュメントのリンクをREADMEを書くことでプロジェクトへの理解が容易になる上に不要なコミュニケーションコストの削減につながります また、環境構築の手順も記載することで個々人の技術レベルに依存せずに誰でも開発構築ができるようになるのでぜひ書いてほしいですね READMEに書いておきたい項目 あくまで一例ですが私が普段READMEに記載しているのは以下の通りです 使用している主な技術 プロジェクトの概要 必要な環境変数やコマンド一覧 ディレクトリ構成 開発環境の構築方