これは機械翻訳されたテキストであり、誤りを含む可能性があります！
優れたドキュメントは、物事がどのように機能するかを思い出すことと、サーバーがダウンし、誰もセットアップ方法を覚えていない日曜日の23時に立ち往生することの違いです。 ドキュメントは、IT 運用で最もエキサイティングな部分ではないかもしれませんが、最も重要な部分の 1 つです。
ドキュメント化する理由
| 理由 | 説明 |
|---|---|
| 記憶 | 6ヶ月後にはすべてを覚えているわけではありませんし、覚える必要もありません |
| 共同作業 | 他の人があなたに尋ねることなく、あなたが何をしたのかを理解できる必要があります |
| トラブルシューティング | 何か問題が発生した場合、何が正常であるかを知ることは非常に貴重です |
| 再構築 | サーバーが故障した場合、正確にどのように設定されていたかを知る必要があります |
| 説明責任 | 何が、いつ、誰によって変更されましたか？ |
Skriv dokumentasjonen for “fremtidig deg”
最も良い指針は、6ヶ月後の自分に説明するように書くことです。そうすれば、物事を複雑にしすぎることなく、十分な詳細を含めることができます。
IT 運用におけるドキュメントの種類
ネットワーク図
ネットワーク図は、ネットワークの物理的および/または論理的構造を示します。単純なスケッチから、VLAN、IPアドレス、ファイアウォールルールを含む詳細な図まで、さまざまなものがあります。
優れたネットワーク図には、以下が含まれている必要があります。
- すべてのネットワークデバイス（スイッチ、ルーター、ファイアウォール、アクセスポイント）
- サブネットを含むVLAN構造
- 重要なデバイス（サーバー、ゲートウェイ）のIPアドレス
- デバイス間の接続
IPプラン
IPプランは、ネットワーク内でIPアドレスがどのように割り当てられているかの概要です。整理整頓に役立ち、競合（同じアドレスを持つ2つのデバイス）を回避するのに役立ちます。
例：
| VLAN | 名前 | サブネット | ゲートウェイ | DHCP範囲 | 備考 |
|---|---|---|---|---|---|
| 10 | 管理 | 10.0.10.0/24 | 10.0.10.1 | .100 - .200 | アクセス制限 |
| 20 | 従業員 | 10.0.20.0/24 | 10.0.20.1 | .100 - .250 | |
| 30 | 学生 | 10.0.30.0/24 | 10.0.30.1 | .100 - .250 | インターネットのみ |
| 50 | サーバー | 10.0.50.0/24 | 10.0.50.1 | なし（静的） | 固定IPアドレス |
静的アドレス：
| IPアドレス | デバイス | ロール |
|---|---|---|
10.0.50.10 | web-01 | Nginx |
10.0.50.11 | db-01 | PostgreSQL |
10.0.50.12 | monitoring-01 | Grafana + Loki |
10.0.50.20 | proxmox | Hypervisor |
チェックリスト
チェックリストは、何も忘れられないようにするために役立ちます。特に、新しいサーバーのセットアップやセキュリティレビューなど、あまり頻繁に行わないタスクに役立ちます。
例：新しいLinuxサーバーのチェックリスト：
- オペレーティングシステムをインストールする (Debian/Ubuntu)
- すべてのパッケージを更新する (
sudo apt update && sudo apt upgrade) - sudoアクセス権を持つユーザーを作成する
- SSH経由でのrootログインを無効にする
- ファイアウォールを設定する (
ufw) - 必要なソフトウェアをインストールする
- バックアップを設定する
- サーバーをIP計画にドキュメント化する
- サービスが機能することを確認する
変更ドキュメント
本番環境（サーバー、ネットワーク、サービス）に変更を加えるたびに、それを記録してください。単純なログで十分です。
## Endringslogg
### 2026-04-14 - Oppgradert Nginx
- **Hva:** Oppdatert Nginx fra 1.24 til 1.26
- **Hvorfor:** Sikkerhetsoppdatering (CVE-2025-XXXX) // セキュリティアップデート (CVE-2025-XXXX)
- **Hvem:** Ola
- **Resultat:** OK, ingen nedetid
### 2026-04-10 - Nytt VLAN for IoT
- **Hva:** Opprettet VLAN 40 for IoT-enheter
- **Hvorfor:** Isolere IoT fra resten av nettverket // IoTをネットワークの残りの部分から隔離する
- **Hvem:** Kari
- **Resultat:** OK, alle printere flyttet til VLAN 40
Bruk Git!
もしあなたがMarkdownファイルでドキュメントを書いている場合（推奨）、Gitを使ってバージョン管理することができます。そうすれば、すべての変更の履歴が自動的に記録され、誰が何をいつ変更したかを確認できます。
運用ドキュメント
運用ドキュメントは、システムが現在の状態でどのように機能するかを記述します:
| 何 | 例 |
|---|---|
| システムアーキテクチャ | “Proxmox を実行し、web、db、monitoring の 3 つの VM があります” |
| アクセス情報 | “ポート 22 経由の SSH、VPN からのみ” |
| バックアップルーチン | “毎日 02:00 に外部ディスクにバックアップ” |
| 連絡先情報 | “問題が発生した場合は、Ola (admin) に連絡してください” |
| 復旧手順 | “再起動コマンド: sudo systemctl restart nginx“ |
ドキュメント作成ツール
| ツール | 何に使用するか | 利点 |
|---|---|---|
| Markdown | シンプルな書式設定のテキスト | 軽量、ポータブル、Git と連携可能 |
| draw.io | 図やネットワーク図 | 無料、視覚的、画像にエクスポート可能 |
| Obsidian | Markdown とリンクを備えたノートアプリ | 個人的な知識ベースに最適 |
| MkDocs | Markdown をウェブサイトとして公開 | プロフェッショナルなドキュメント |
| Git/GitHub | ドキュメントのバージョン管理 | 履歴、共同作業、バックアップ |
課題 1 - 簡単なネットワーク図を作成する
draw.io (無料) を使用して、自宅または学校のネットワークを描画してください。
- インターネット接続とルーターから始めます。
- スイッチとアクセスポイントを追加します。
- サーバー、PC、その他のデバイスを描画します。
- IPアドレスがわかっている場合は、書き込んでください。
完璧である必要はありません。ネットワークを視覚的に考え始めることがポイントです。
課題 2 - 自分のチェックリストを作成する
定期的に IT で行うこと (例: 新しい VM のセットアップ、開発マシンのインストール、VS Code の設定) について考えます。そのプロセスのチェックリストを作成してください。
- すべてのステップは何ですか？
- 何を最もよく忘れますか？
- ステップを簡略化できるものはありますか？
次回使用できるように、Markdown ドキュメントに保存してください。
課題 3 - あなたのサービスの1つを文書化する
あなたがセットアップしたサービス（VM、Dockerコンテナ、Webサーバーなど）を1つ選択し、短い運用ドキュメントを作成してください。
- そのサービスは何をしますか？
- どのように起動/停止しますか？
- IPアドレスとポートは何ですか？
- バックアップはありますか？
Markdownで記述し、Gitリポジトリに配置してください。
要約
- 未来のあなたへのドキュメント: 何も知らない人に説明するように書いてください
- **ネットワーク図**と**IP計画**は、インフラストラクチャの概要を提供します
- **チェックリスト**は、繰り返しのタスクで何も忘れられないようにします
- **変更ログ**は、いつ、誰が何をしたかを追跡します
- **運用ドキュメント**は、システムが現在どのように機能するかを説明します
- 簡単でバージョン管理されたドキュメントには**Markdown + Git**を使用してください