Coockar

公開日: 約1分

Markdown の脚注をどこまで使うか

技術記事で脚注が本当に必要になる場面は少ない。本文に入れるべきもの・リンクで済むもの・脚注に残すものの線引きを考える。

Markdown 拡張で脚注が使えるようになると、つい多用したくなる。しかし画面で読む技術記事では、脚注は紙の本ほど機能しない。ジャンプして戻る操作は読みの流れを切るし、モバイルでは戻り先を見失いやすい。

線引きの実験

過去記事の脚注を全部見直して、三つに分類した。

  • 本文に昇格: 前提条件や注意書き。読み飛ばされると困るものは脚注に置くべきではなかった
  • リンクに変換: 出典・一次情報への参照。アンカーテキストを工夫すれば本文の流れに収まる
  • 脚注のまま: 本筋と無関係な余談や、バージョン固有の細かい挙動メモ

結果として脚注に残ったのは全体の二割ほどで、大半は本文かリンクで表現できた。

実装面の注意

脚注記法はプロセッサの拡張に依存するため、処理系を替えると出力が変わる。戻りリンクの aria-label が処理系任せになる点も、アクセシビリティ検査で一度指摘が出た。多用しないと決めたことで、この依存も小さく保てている。

まとめ

脚注は「無いと本文が濁る時の最後の置き場」くらいの位置づけがちょうどよい。まず本文かリンクで書けないかを試すと、記事は素直になる。