github でドキュメントを格納するフォルダ名どどうすれば管理しやすいかいつも悩みます。
大枠のテンプレートを考えてみました。
一般的なフォルダ名の例
一般的によく使われるフォルダ名の例を考えてみました。
| docs/ | ドキュメント全般 |
| documentation/ | docs/の別表記 |
| guide/ | ガイドラインや使用方法 |
| manual/ | マニュアル系の資料 |
| specs/ | 仕様書 |
| design/ | 設計関連 |
| meeting-notes/ | 会議議事録 |
| proposal/ | 提案書 |
| reports/ | レポートや進捗資料 |
フォルダ構成のサンプル
以下のような構成のテンプレートを検討してみました。
project-root/ │── docs/ │ ├── README.md │ ├── setup-guide.md │ ├── api/ │ │ ├── api-reference.md │ │ ├── endpoints.md │ ├── design/ │ │ ├── architecture.md │ │ ├── database-schema.md │ ├── meeting-notes/ │ │ ├── 2024-02-19-meeting.md │ │ ├── 2024-02-12-meeting.md
補足
メリット
- [docs/] フォルダにすべてのドキュメントをまとめることで、わかりやすく管理できる。
- [api/] や [design/] などのサブフォルダを作成すると、関連資料を整理しやすい。
- [meeting-notes/] のように日付でファイル名を管理すると、時系列で探しやすい。
