説明とは相手の頭の中を整理すること。自分の頭も整理されていないとならない。
よって「説明の順番を考えることは良記事に必須」という話。
を基にするが、ポイントとしては以下である。
説明の順番
- 場所ごと（Location）
- アルファベット、五十音（Alphabet）
- 時系列、物語順（Time）
- カテゴリ別（Category）
- 階層、重要度順（Hierarchy）
「LATCH」という考え方がある。重要度も広義で階層と言えるのかなと考える。
では具体的に、説明の順番をかんがえると、いい記事がかけるものだろうか。
Qiitaのランキングに登場した良記事たちを基に、良い説明の順番を見てみた。
2020年のLGTM数ランキングを参考。
各種、良記事はどう説明の順番を整頓しているか
以下のようになりそう。
場所ごと（Location）あるいは アルファベット、五十音（Alphabet）
- エンジニアの情報収集法まとめ
- 何かのときにすっと出したい、プログラミングに関する法則・原則一覧
- 「AWS is 何」を3行でまとめてみるよ
- GitHubで使われている実用英語コメント集
- ネイティブと働いて分かった英語コミットメッセージの頻出動詞10つ
- すべての新米フロントエンドエンジニアに読んでほしい50の資料
- [初心者向け] RubyやRailsでリファクタリングに使えそうなイディオムとか便利メソッドとか
- コードを書く際の指針として見返すサイトまとめ
時系列、物語（Time）順に並んでいるもの
- 一番分かりやすい OAuth の説明
- AtCoder に登録したら次にやること ～ これだけ解けば十分闘える！過去問精選 10 問 ～
- 新人プログラマに知っておいてもらいたい人類がオブジェクト指向を手に入れるまでの軌跡
- 数学を避けてきた社会人プログラマが機械学習の勉強を始める際の最短経路
- オブジェクト指向と10年戦ってわかったこと
- もう保守されない画面遷移図は嫌なので、UI Flow図を簡単にマークダウンぽく書くエディタ作った
- 開設後３週間で収益１０万円を得た個人開発サイトでやったことの全部を公開する
- Chrome拡張の高速な英語辞書ツールをつくりました(Mouse Dictionary)
- 初心者向け、「上手い」シェルスクリプトの書き方メモ
- Google社のテクニカルライティングの基礎教育資料がとても良かったので紹介したい
- 【図解】Dockerの全体像を理解する -前編-
- いまさらだけどDockerに入門したので分かりやすくまとめてみた
- Pythonを書き始める前に見るべきTips
- エンジニアなら知っておきたい、絵で見てわかるセキュア通信の基本
- 要件定義～システム設計ができる人材になれる記事
- エンジニアの劣等感との付き合い方
- メンバーに恨まれそうな3つのコードレビュー施策を徹底したら、逆にメンバーが爆速で成長した話
カテゴリ（Category）別に並んでいるもの
- ロシアの天才ハッカーによる【新人エンジニアサバイバルガイド】
- プログラミングでよく使う英単語のまとめ【随時更新】
- うまくメソッド名を付けるための参考情報
- 非デザイナーエンジニアが一人でWebサービスを作るときに便利なツール32選
- 【まとめ】これ知らないプログラマって損してんなって思う汎用的なツール 100超
- イマドキのJavaScriptの書き方2018
- VSCodeのオススメ拡張機能 24 選 (とTipsをいくつか)
- 2018年の最先端バックエンドエンジニアに必要なスキルについて考えてみました。
- インフラエンジニアとしてよく使うコマンド集
- モデルやメソッドに名前を付けるときは英語の品詞に気をつけよう
- AWSアカウントを取得したら速攻でやっておくべき初期設定まとめ
- 個人でも使える！おすすめAPI一覧
- Go言語の初心者が見ると幸せになれる場所 #golang
- 2020年のフロントエンドマスターになりたければこの9プロジェクトを作れ
階層、重要度（Hierarchy）順に並んでいるもの
- Markdown記法 チートシート
- ペアプログラミングして気がついた新人プログラマの成長を阻害する悪習
- 質問は恥ではないし役に立つ
- Gitのコミットメッセージの書き方
- Reactを使うとなぜjQueryが要らなくなるのか
- インフラエンジニアじゃなくても押さえておきたいSSHの基礎知識
- 良いコードの書き方
- 使えるRSpec入門・その1「RSpecの基本的な構文や便利な機能を理解する」
- Vim幼稚園からVim小学校へ
- ウェブカツ運営者が語る！エンジニアで稼ぐために大切な２０のコト
- プロジェクトリーダーというお仕事
「LATCH」考察
場所（Location）、アルファベット（Alphabet）順というのはなかなか乱暴なのだが、ともかく全網羅しているものをそこに分類してみた。
- 「～の話」。は当然ストーリー性が有り、共感性があり、だからわかりやすい。
- 逆に少数だが、ともかく数「まとめ」た記事も圧巻。「～のまとめ50」、等。辞書的価値が出せているということか。
- ただいずれも少なくとも
- カテゴリ
- 時系列、物語順
- 階層、あるいは重要度
でまとまっている。かつ例外なくどの記事もまとまっている。
まとめ
説明の順番を考えることは良記事に必須。参考図書:
確かに説明の順番がスッキリすることによって理解度、腹落ち度が全く変わる。
ということで説明の順番を考えて文書を作りたいなという話 でした。
以上です～。