README.mdを新規作成し、自宅ネットワークの設計・運用メモとドキュメントを整理

This commit is contained in:
Yuto Yamazaki
2026-03-11 13:18:20 +09:00
parent e74f3ce68c
commit 72cf523232

31
README.md Normal file
View File

@@ -0,0 +1,31 @@
# HomeNetwork — 自宅ネットワーク資産リポジトリ
このリポジトリは、自宅ネットワークの設計・運用メモ、ドキュメント、構成ファイルを一元管理するためのものです。
目的:
- ネットワーク構成図、IP割当、運用メモを参照・更新できるようにする
- Docker やサーバ構成のポート情報をまとめる
- 設備増備計画やラック構成などの設計ドラフトを整理する
主要ディレクトリ:
- `docs/` — 最終化したドキュメントNetwork図、増備計画、ポート一覧など
- `feature/` — 検討中の設計やドラフト(各サブディレクトリに README を置き、目的を明記しています)
- `now/` — 現在の運用メモと即時参照用ドキュメント
- `.prompt/` — このリポジトリの編集方針や AI 補助プロンプト
運用上の注意:
- 空ディレクトリのプレースホルダとして `.gitkeep` は削除済みです。空ディレクトリを残す場合は、目的を記載した `README.md` を配置してください。
- ドキュメントを更新したら `docs/` に移すか、`feature/``now/` の使い分けルールに従ってください。
- Docker 関連のポート情報は `docs/DOCKER_PORTS.md` にまとめてあります。compose ファイルに変更があれば更新をお願いします。
編集の流れ(推奨):
1. 小さな変更(文言修正・軽微な追記)は `now/` 配下の該当ファイルを編集
2. 設計変更や新規ドキュメントは `feature/` に草案を置き、確定後 `docs/` へ移動
3. 重要な運用変更はコミットメッセージに目的を明確に記載
問い合わせ・連絡:
- リポジトリ管理者に issue を立ててください。
---
更新履歴:
- 2026-03-11: ディレクトリ整理、`docs/` 集約、`docs/DOCKER_PORTS.md` 追加