/note/tech
- ドキュメント全体が箇条書きで書かれているケースは多い
- 例えば、この文書自体のような
- 箇条書きでドキュメントを著すことに関する賛否両論はあるが、簡便かつ有益であることも多く、個人的には良いと思っている
- とはいえ、読みにくい箇条書きドキュメントというものも存在する
- その特徴はインデントがやたら多いというものである
- 補足事項や事例など主題では無い情報をインデントすることで何らかの構造を表現したい意図があるのだろう
- しかし、大抵の場合インデントしたところで然程構造化されているわけでもなく、書いた人間の整理されない思考がそのままアウトプットされているに過ぎないので、大変読みにくい
- 箇条書きは読みやすさに特化した表記法なので、読みにくい箇条書きは存在自体が害悪である
- 大抵の箇条書きドキュメントでインデントは必要なく、補足的な説明も同レベルに置いた方が結果的に読みやすくなる
- あえてインデントする場合は1階層だけに留めておく方が無難
- どうしても深い階層を使いたい時はむしろ別の章・項を立てた方が良い
- 箇条書きのあるべき姿はワンセンテンスに圧縮された情報の羅列による空間効率の良い表記にある
(2024/12/28)