ドキュメントファイルの目次が必要なときのメモ

使える場面

ドキュメント作成時に目次,索引,インデックスのファイル化が必要なとき
非エンジニアも含めたチームメンバーでドキュメントファイルを一覧で見たいとき
人から大量のドキュメントを渡されて**「後読んどいて」**と言われた時のドキュメント全量把握するとき

前提

treeコマンドが使える必要があります
今回はmac上で実行

おすすめ

ドキュメント階層のルートディレクトリで以下コマンドを実行

$ tree -NCH ./ > ./document_index.html

オプション説明

option	効果
-N	表示できない文字を8進数に置き換える,文字化け対策
-H	html形式で出力する, 必須
-C	テキストに色をつける, お好み

sample

document_index.html

Directory Tree
./
├── DirA
│   ├── sample01.txt
│   ├── sample02.txt
│   └── sample03.txt
├── DirB
│   └── sample04.txt
├── DirC
│   ├── DirD
│   │   └── sample06.txt
│   └── sample05.txt
└── document_index.html

環境次第だけどディレクトリ等はテキストカラーが変更されていたり、ディレクトリ、ファイルはリンクになっています。
treeコマンドはconsole出力するのが一般的だと思いますが、htmlのほうがユーザーフレンドリー。
状況によってはブラウザ経由でpdf化する手もアリかと思います。