もう毎回同じフォーマットを作るのめんどい of めんどいので、ここに書いておきます。あくまで軽率なアウトプット用なので、用意周到なアウトプットをしたい方は使わない方が良いと思います。
前提
そのアウトプットを読む人に認識しておいて欲しい前提知識や条件をここに書いておきます。軽率に箇条書きで良いと思います。特に説明する必要がない場合は、ここはカットしても良いかと。
例）
- 長らくお世話になっていたPaperclip が deprecatedになったため、ActiveStorage に引っ越しすることにした。
- ORM は ActiveRecord ではなく、Mongoid を使用。 view 側でフラグメントキャッシュを使う時のキャッシュキーはインスタンス変数そのものを使っていた。
- 周りの上司はほぼ全員Vimmerだったため、自分も最初はビジネスVimmerを名乗り、隠れてVSCodeを使っていた。
※ それぞれ例として上げた箇条書きは互いに無関係で独立したものです。
環境
そのアウトプットをした際の開発環境を書いておきます。ここは結構大切だったり。あとあと試してうまくいかなかった時、バージョンが違うことが原因だった…とかだと悲しいので。
例）
- ruby 2.5.0
- Ruby On Rails 5.2.0
- Mongoid 6.0.0
- Docker
TL;DR
結論ありき。まず最初に一番重要な点を書いておきます。いちいちスクロールするのだるいので。最終的なコードや計測結果、設計、ワークアラウンドなどなど。
/*
タイトルに対応する結果とかをここに書くようにすると、パッと見て分かりやすいかと思います。
*/
実行手順／再現手順／詳細
結論に至るまでの手順とか、「ここは詳細に説明しておいた方が良いかな…」と思った部分を軽率に説明します。特に必要ない場合は書かなくても良いと思います。なるべく軽率にアウトプットしていきたいので。
もし書く場合は、以下のような感じで番号付き見出しとかでそれぞれまとめると良いかもしれません。
1. まずは VSCode をインストール
かくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじか
2. 次に VSCode の好みのプラグインをインストール
かくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじか
3. 最後に Atom をアンインストール
かくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじかかくかくしかじか
参考文献
そのアウトプットをするまでに参考にしたドキュメントや記事のリンクを貼っておきます。これも結構重要だったりします。あとあともっと詳しく調べたい時とかにまた一から調べ直すのもそれはそれで軽率だと思います（？）。
（以下マークダウンのフォーマット）
# 前提
# 環境
# TL;DR
# 実行手順／再現手順／詳細
# 参考文献