コードと、その理由を残す

コードを読むと、何をしているかは分かります。でも、なぜその方法を選んだのかは、コードだけでは分からないことがあります。

動く例を小さくする

メモに載せるコードは、伝えたいことが見えるところまで小さくすると読みやすくなります。

type Note = { title: string; draft: boolean };

const publishedNotes = (notes: Note[]) =>
  notes.filter((note) => !note.draft);

この例で伝えたいのは、公開するメモの選び方です。保存方法や画面の作り方は、必要になったところで説明できます。

前提をひとこと添える

入力がどんな形なのか、どの環境で試したのか。その前提が一行あるだけで、読み手は自分の状況に当てはめやすくなります。

選んだ理由を添える

比較した方法を全部書く必要はありません。今回の判断に関わる違いだけを残します。

未解決のことも書く

分からない部分は、分からないまま記録しておく。結論を急ぐより、次に調べることが見えている方が、メモとして役に立つことがあります。