BT belgelendirmesi ve ağ belgelendirmesi: başkaları da anlasın

Kısaca: İyi BT belgeleri; ağ planını, adresleri, yapılandırmaları, erişimleri ve yöntemleri güncel kaydeder; böylece olaylar daha hızlı çözülür ve vekâlet mümkün olur.

Biraz daha ayrıntılı: “Bunu yalnızca Max biliyor” bir risktir. Belgelendirme acil durumda saatler kazandırır, işe alıştırmayı, denetimleri ve devirleri kolaylaştırır. Güncel, bulunabilir ve korumalı olmalıdır.

Ayrıntılı

Neler belgelenir

• Ağ planı (mantıksal: alt ağlar/VLAN’lar/yönlendiriciler/güvenlik duvarı; fiziksel: konumlar, kabinler, yama panelleri, prizler).
• IP adres planı (aralıklar, statik adresler, DHCP havuzları, DNS adları).
• Cihazlar/envanter (seri numarası, konum, sorumlu kişiler).
• Yapılandırmalar (yönlendirici/anahtar/güvenlik duvarı dışa aktarımları, sunucu rolleri, sürümler), bağımlılıklar.
• Erişimler (parola yöneticisinde/kasada, wiki’de düz metin değil).
• Yöntemler/runbook’lar (yedekleme, geri yükleme, yeniden kurulum, acil durum).
• Değişiklikler (changelog), sözleşmeler/SLA’lar/lisanslar, iletişim bilgileri.

Araçlar ve biçim

• Diyagramlar: draw.io/diagrams.net, Visio, Excalidraw, Mermaid/PlantUML (kod olarak diyagramlar, sürümlenebilir).
• Wiki/bilgi tabanı: Confluence, BookStack, Wiki.js, Obsidian, bir Git deposunda Markdown (docs-as-code).
• Ağ araçları: NetBox (IPAM/DCIM), phpIPAM; otomatik üretilen belgeler (dışa aktarımlar, Ansible facts).
• Standartlar: tek tip adlandırma (örn. sw-bk-01), şablonlar, sürüm/tarih, belge başına sahip.
• Güncellik: belgelendirme görevin parçasıdır (değişiklik → belgeler), düzenli incelemeler; eskimiş belgeler tehlikelidir.

İyi uygulama

• Hedef kitleye dikkat edin: yeni başlayan kılavuzu ve ayrıntılı başvuru.
• Kısa, kesin, ekran görüntüleri/diyagramlarla, örnekler ve komutlar.
• Kararları gerekçelendirin (neden bu şekilde?).
• Erişim hakları: herkesin her şeyi görmesi gerekmez; ağ planları ve kimlik bilgileri hassastır (saldırı planı!).
• Belgeleri yedekleyin (yalnızca arızalanan sistemde değil; acil durum çıktısı/çevrimdışı kopya).
• Test: başka biri görevi belgelerden çözebiliyor mu?
• Projeler/final sınavı için: hedef/gerçek analizi, ağ planı, kavram, testler, teslim içeren belgeler.

Örnek: bir ev/ofis ağı için mini ağ belgeleri

1. Diyagram: İnternet → yönlendirici/güvenlik duvarı (192.168.1.1) → anahtar → istemciler/NAS/yazıcı; Wi-Fi SSID’leri (misafir ayrılmış).
2. Tablo: cihaz, IP, MAC, konum, amaç.
3. DHCP aralığı 192.168.1.100–199, sabit IP’ler .10–.50.
4. Erişimler parola yöneticisinde (yönlendirici yöneticisi, Wi-Fi, NAS).
5. Acil durum: yönlendiriciyi sıfırla, yapılandırma yedek dosyası (tarih), sağlayıcı yardım hattı.
6. Tarihli değişiklik günlüğü. Bu, bir değişikliği (yeni yönlendirici, yeni yönetici) de sorunsuz kılar. Bkz. ağ planı, kablolama planı, envanter.

Ayrıca bak: Ağ planı ve Gantt, Kablolama planı, BT varlık yönetimi