エンジニア必須知識！？みんなから好かれるREADME.mdの作り方

こんにちは。エンジニアの山田です。

みなさん、READMEを書いたことがありますでしょうか。
エンジニアの方なら一度は見たことがあると思います。

README（リードミー）とは？

説明書であり『まず最初に読んでほしいドキュメント』です。
READ（読んで！） ME（私を！）ですので、READMEファイルがあるプロジェクトはぜひ読むようにしましょう。

READMEは書き手によって精度がまちまちですが、わかりやすく、見やすいREADMEはメンバーから好かれ、ありがたがられます。そして共通認識を持つことで開発・改修がしやすくなります。

今回はそんなREADMEの作り方のポイントを紹介していきます！

ポイント１. かっこいいプロジェクト名

最初にプロジェクト名を記載するのは必須です。学校のテストも名前がなければ0点ですからね！
どんな？だれの？プロジェクトなのかわかるような名前だと素晴らしいです。

例）
- 東京都○○区の職員勤怠管理画面
- ログイントークン発行用API

ポイント２. 必要なツール、環境構築の手順を記載する

どのツールを使っているのか、自分のPCで開発できるのかは開発する前に知りたいですよね。
Windows Proしか動かないのにWindows Homeで環境構築なんてした暁には…（絶望）
環境構築で無駄な時間が発生しないように、どんな技術を使っているのかざっくり記載するようにしましょう。

例）

• DBツール
• 使用パッケージ
• 対応OS

#パッケージインストール
npm install
#サーバー起動後、localhost:8080にアクセスする
npm start

ポイント３.設計手法、スタイルガイドを記載する

設計手法は、どんな思想で開発するか。どのような設計をするかを記載します。

スタイルガイドはチームやプロジェクトで統一するコードやスタイルの書き方です。
変数名や各要素は共通のルールを決めなければ無法地帯となってしまいます。
最低限揃えてほしい内容を記載しておきましょう！

例）
スタイルガイドは下のリンクを参考にしてください
公式ドキュメントや参考リンクなど
※どこにも遷移しません

いかがでしたでしょうか。
チーム開発で役立つ情報が提供できたら幸いです！