社内のレポジトリのreadmeテンプレ

internal-repo-readme-boilerplate.md

プロジェクト名（サーバー名やバッチ名）

タイトルだけだとわからない場合は1行説明

Overview

なんか
すごい
わかった気になる
図

• hoge
• fuga

Development

Prereq

Setup

make deps

Run

make run

Test

make test

Production

• どこでどのようにいつうごいているのか
• 確認方法のリンク先
• アラートの送信先

Deploy

• デプロイ方法かCDツールへのリンク

Notes

• あまり書きすぎずネタに走らず追記事項があれば書く

ブログにかいた→

https://tomi-ru.hatenablog.com/entry/2019/12/25/%E7%A4%BE%E5%86%85%E3%81%AE%E3%83%AC%E3%83%9D%E3%82%B8%E3%83%88%E3%83%AA%E3%81%AEreadme%E3%83%86%E3%83%B3%E3%83%97%E3%83%AC