BT Danışmanlık

BT Dokümantasyonu: Kurumsal Hafıza Nasıl Kurulur?

BT dokümantasyonu nasıl yapılır? Ne yazılır ne yazılmaz, envanterden kablo etiketine kadar içinde ne bulunur, nerede tutulur ve güncel kalmasını ne sağlar.

İlker Pehlivan

BT dokümantasyonu, bir kurumun bilişim sisteminin nasıl kurulduğunu, neyin neye bağlı olduğunu ve neden öyle yapıldığını, o sistemi devralacak kişinin okuyabileceği biçimde yazıya geçirmektir. Tanımın son parçası en önemlisi: dokümantasyon bugünkü ekip için değil, yarın gelecek kişi için yazılır.

Orhun Yazıtları’nda Bilge Kağan, taşı yalnız zaferleri anlatmak için oydurmadı. Metin boyunca gelecek kuşaklara seslenir, devletin nasıl yönetilmesi gerektiğini söyler ve yapılan hataları da kaydeder. Bir kurumun sistem kaydı da bu işi görür: kimin ne yaptığını değil, o işin neden öyle yapıldığını gelecek nesle taşır. Bu makale boyunca aynı taşa döneceğiz, çünkü sorularımızın çoğu aynı sorular: neyi kazıyacaksınız, nereye dikeceksiniz ve okuyacak kişi geldiğinde taş hâlâ doğruyu söylüyor olacak mı?

Bu makale BT danışmanlığı hizmetimizin kurumsal hafıza koluna odaklanıyor. Bir kurumda yıllarca birikmiş dağınık bilgiyi tek yerde nasıl topladığımızı BT dokümantasyon sistemi vakamızda adım adım anlattık; burada o işin arkasındaki yöntemi konuşuyoruz.

BT dokümantasyonunun kurumsal hafıza karşılığı: bozkırda dikili bir yazıt taşı, üst yüzü baştan aşağı kazınmış, alt üçte biri hâlâ boş ve ustası kalemiyle sınırın üstünde çalışıyor
Taşın üstü dolu, altı hâlâ boş. Kurumsal hafıza da bitmiş bir belge değil, sürmekte olan bir iştir.

BT Dokümantasyonu Nedir, Ne Değildir?

BT dokümantasyonu bir devir belgesidir, bir arşiv değil. Ölçütü tek bir soruyla kurulur: sistemi bilmeyen yetkin bir kişi bu belgeleri okuyarak işi devralabilir mi? Cevap evetse dokümantasyonunuz vardır, hayırsa elinizde yalnız dosyalar vardır.

Bu ayrımı kaçırmak yaygın ve pahalıdır, çünkü iki şey birbirine çok benzer. Bir kurumda yüzlerce ekran görüntüsü, onlarca kurulum notu ve dolu bir paylaşım klasörü bulunabilir; yine de kimse o klasöre bakarak bir sunucuyu devralamaz. Taş benzetmesi burada işe yarıyor: Orhun Yazıtları’nın değeri taşın büyüklüğünde değil, üzerindeki metnin okunabilir ve tam olmasındadır. Yarım kazınmış bir taş, dikilmemiş taştan daha çok yanıltır, çünkü bakan kişi karşısında bir kayıt olduğunu sanır.

Dokümantasyonun ne olmadığını da söylemek gerekiyor, çünkü her üçü de sık sık onun yerine geçiriliyor:

  • Yedek değildir. Yedek veriyi geri getirir, dokümantasyon kararı geri getirir. İkisi farklı kayıplara karşı çalışır ve biri diğerinin yerine geçmez; yedekleme tarafının kendi kuralları veri yedekleme ve felaket kurtarma yazımızda.
  • Envanter listesi değildir. Envanter neyin var olduğunu söyler, dokümantasyon neden orada olduğunu. Envanter dokümantasyonun bir bölümüdür, tamamı değil.
  • Beyan değildir, olgu iddiasıdır. Yazılan şey sahadaki durumla uyuşmak zorundadır. Bu ayrımın en net göründüğü yer gölge sistemlerdir: dokümante edilmemiş bir API kayıtta olmadığı hâlde çalışmaya devam eder, yani kurumun beyanı ile sunucunun olgusu ayrışır. Kurumun kaydında olmayıp sahada çalışan her şey aynı aileden: cihaz, uygulama, yapay zekâ aracı ya da yetkisi unutulmuş bir hesap.

Dokümantasyonda Neyi Yazarsınız, Neyi Yazmazsınız?

Dokümantasyonun en sık düştüğü tuzak eksiklik değil, fazlalıktır. Her şeyi yazmaya çalışan ekip kısa sürede hiçbir şey yazmaz olur, çünkü iş imkânsız büyüklükte görünmeye başlar. Ölçüyü kuran soru şudur: bu bilgi, sistemi devralacak kişinin başka bir yerden bulamayacağı bir şey mi?

Yazılacak olan, kararın kendisi ve gerekçesidir. Bir ayarın hangi değere çekildiği yarı bilgidir; asıl kayıt o değerin neden seçildiğidir. Bilge Kağan’ın taşındaki asıl ders de bu: metin olayları sıralamakla kalmaz, hangi kararın niye alındığını ve neyin yanlış gittiğini söyler. Altı ay sonra bir ayarı değiştirmek isteyen kişi, gerekçeyi bilmiyorsa ya dokunmaya korkar ya da bilmeden bir şeyi bozar.

Yazılmayacak olan, üreticinin zaten yazdığıdır. Bir ürünün genel kurulum adımları onun kendi dokümantasyonunda durur ve sizinkinden daha güncel kalır. Sizin kaydınız sizin kurumunuza özgü olanı taşır: hangi sürümü neden seçtiniz, standart dışına nerede çıktınız, hangi ayarı hangi sorun yüzünden değiştirdiniz.

Pratikte ayrımı şu üç soru veriyor:

  1. Bu bilgi bizim kurumumuza mı özgü? Değilse üreticinin belgesine link vermek yeterlidir.
  2. Bu bilgi olmadan iş durur mu? Duruyorsa yazılır, durmuyorsa sıraya girer.
  3. Bu bilgiyi yalnız bir kişi mi biliyor? Evetse en acil satır odur; kurumdaki tek nokta arızası çoğu zaman bir cihaz değil, bir kişidir.

Üçüncü soru aynı zamanda başlangıç sırasını verir: dokümantasyona en çok risk taşıyan yerden başlanır, en kolay yazılacak yerden değil.

Bir BT Dokümantasyonunda Ne Bulunur?

Kapsam beş katmanda toplanır ve sırası tesadüf değil: her katman bir öncekinin üstünde durur. Envanteri olmayan bir kurum topolojisini çizemez, topolojisi olmayan bir kurum erişim haritasını çıkaramaz.

Envanter: Neyin Var Olduğu

Envanter, kurumdaki her cihazın ve her sistemin kayıtlı olduğu temel katmandır. Marka ve model kadar önemli olan üç alan var ve genellikle bu üçü eksik kalıyor: cihaz nerede duruyor, kim sorumlu ve ne zaman devreye girdi. Sonuncusu ömür planlaması için gereklidir ve sonradan hatırlanamaz.

Envanterin elle tutulan hâli ilk yılını zor çıkarır. Bir kurum belli bir ölçeğe geldiğinde kaydı cihazların kendisinden toplayan bir sisteme geçmek gerekir; bu katmanın kendi ayrıntısı BT envanter yönetimi sayfasında duruyor. Envanterin kör noktası ise her zaman aynı yerdedir: kayıtta olmayan ama ağda çalışan cihazlar, yani gölge BT.

Topoloji ve Adresleme: Neyin Nereye Bağlı Olduğu

Topoloji, cihazların birbirine nasıl bağlandığını gösteren katmandır ve iki parçası vardır: fiziksel bağlantı (hangi kablo nereye gidiyor) ve mantıksal bölümleme (hangi cihaz hangi ağ bölümünde). İkisi aynı belge değildir ve birbirinin yerine geçmez. Fiziksel bağlantının en kolay bayatlayan belge olduğunu hesaba katın: biri bir kabloyu başka porta taktığında çizim yanlış kalır. Switch’lerin komşu tablosu ise her yarım dakikada kendiliğinden güncellenir; çizimi onunla karşılaştırmanın yolunu LLDP nedir yazımızda anlattık.

Bu katmanın en çok ihmal edilen parçası adresleme planıdır. Hangi aralığın neye ayrıldığı yazılı değilse, ağa yeni bir cihaz eklemek tahmin işine döner ve çakışmalar aylar sonra açıklanamayan kopmalar olarak geri gelir. Yazılması gereken şey mevcut adres listesi değil, ayırma mantığıdır: hangi blok neye rezerve edildi ve neden.

Erişim ve Kimlik: Kimin Neye Girebildiği

Bu katman iki soruyu cevaplar: sistemde hangi ayrıcalıklı hesaplar var ve bunlara kim erişebiliyor? Kayıt, hesabın varlığını ve yerini taşır; parolanın kendisini taşımaz. Parola kasada durur, dokümantasyon kasadaki kaydı işaret eder.

Bu ayrım teorik değil. Bir kamera sisteminin ayarına girilemediği için uyum maddesinin kâğıt üstünde kaldığı durumu IP kamera sistemi kurulumu sayfasında anlatıyoruz: cihaz çalışıyordu, görüntü akıyordu, ama parolayı bilen kişi yıllar önce kurumdan ayrılmıştı. Erişim katmanı tam da bu kaybı önlemek için vardır.

Yordam: İşin Nasıl Yapıldığı

Yordam, tekrar eden işlerin adım adım yazıldığı katmandır: yeni personel açılışı, ayrılan personelin kapatılması, yedekten dönüş, bir cihazın değiştirilmesi. Ölçütü şudur: o işi hiç yapmamış bir ekip arkadaşı, yordamı okuyarak yapabilmeli.

Buradaki asıl kazanç hız değil tutarlılıktır. Aynı iş üç kişi tarafından üç farklı biçimde yapıldığında ortaya çıkan sonuç, kimsenin tam olarak bilmediği bir sistemdir. Yordam, işi yavaşlatmaz; işi her seferinde aynı yapar.

Yordamın en sinsi kusuru da tam burada doğar: onu yazan kişi işi zaten biliyordur ve kendisine bariz görünen adımları farkında olmadan atlar. Bunun bir adı var: uzmanlık laneti. Çaresi yazarken daha dikkatli olmak değil, yordamı o işi hiç yapmamış birine denettirmektir: takıldığı her yer, yazıda eksik kalan bir adımdır. Bu deneme yordamı yazan kişinin kendisi tarafından yapılamaz, çünkü o kişi zaten atladığı adımı kafasından tamamlar.

Değişiklik Kaydı: Neyin Ne Zaman Değiştiği

Değişiklik kaydı, sistemde ne zaman neyin değiştiğini ve kimin değiştirdiğini tutan katmandır. Değeri arıza gününde ortaya çıkar: bir şey dün çalışıyorsa ve bugün çalışmıyorsa, arada ne olduğunu bu kayıt söyler.

Kaydın faydalı olması için iki alan şart: değişikliğin gerekçesi ve geri alma yolu. Gerekçesiz kayıt bir sonraki kişiye hiçbir şey öğretmez; geri alma yolu yazılmamış bir değişiklik ise gece yarısı çözülemez.

Sahada Duran Dokümantasyon: Etiket, Pano ve Protokol

Dokümantasyonun tamamı ekranda durmaz. Bir kısmı sahada, işin yapıldığı yerde durmak zorundadır ve bu kısım genellikle hiç konuşulmaz. Oysa taş benzetmesinin en doğrudan karşılığı burasıdır: yazıtlar bir kütüphaneye konmadı, olayın geçtiği yere dikildi ve okumak isteyen oraya gitti.

Sahada duran kaydın ortak özelliği şudur: okunacağı an, ekran başında değil elin kirlendiği andadır. Kabinetin arkasında, merdiven üstünde ya da gece yarısı bir arıza sırasında kimse wiki açmaz.

Kablo Etiketi: En Küçük ve En Çok Okunan Belge

Kablo etiketi, kurumdaki en küçük dokümantasyon birimidir ve büyük ihtimalle en çok okunanıdır. Bir hattın iki ucunda da nereye gittiğini söyleyen etiket varsa, arıza anında kabinet önünde geçirilen süre dakikalara iner; yoksa iş kablo çekiştirmeye ve tahmine döner.

Etiketlemenin bir standardı var ve keyfî değil: hangi bilginin hangi sırayla yazılacağı, etiketin nereye konacağı ve renk kodunun ne anlama geldiği tanımlı. Kablolama tarafının bu ayrıntısı, alan sistemleri ve test raporuyla birlikte yapısal kablolama ve zayıf akım rehberimizde duruyor. Buradaki dokümantasyon açısından kritik olan tek şey şu: etiket ile kayıt aynı şeyi söylemek zorundadır. Panelde A-12 yazan port, kayıtta da A-12 olmalıdır; ikisi ayrıştığı anda ikisi de güvenilmez hale gelir.

Sistem Odasındaki Pano: Yerinde Duran Kayıt

Sistem odasının duvarına asılan çerçeveli belge, dijital dokümantasyonun kopyası değildir; onun sahada okunması gereken özetidir. İçine konacak şey azdır ve seçilmiştir: kabinet yerleşim şeması, acil durumda aranacak kişi ve iletişim bilgisi, elektrik ve soğutma için kritik uyarılar, en son güncelleme tarihi.

Son maddeyi atlamayın. Tarihi olmayan bir pano, doğru mu yanlış mı olduğu bilinmediği için bir süre sonra okunmaz olur. Odanın kendisine dair kararlar, yani güç ve soğutma yükünün hesabı ve kabinet düzeni, ayrı bir iştir ve kapsamı sistem odası kurulumu sayfasında.

Protokol: Odaya Giren Kişi İçin Yazılmış Kural

Protokol, o mekânda çalışacak kişinin uyması gereken kuralların yazılı hâlidir ve sistem odasında en çok işe yarayan üçü şunlardır: odaya kimin hangi şartla girebileceği, kabinete yapılan her eklemenin nasıl kaydedileceği ve temizlik ile bakım sırasında nelere dokunulmayacağı.

Sonuncusu küçümsenmemeli. Sistem odasında yapılan temizlik, kural yazılı değilse bir riske dönüşür: yanlış prizin çekilmesi, hava akışını kapatan bir düzenleme ya da kabinet kapağının açık bırakılması. Bunlar kötü niyetle değil, bilgisizlikle olur ve tam da bu yüzden çözümü duvarda asılı yarım sayfalık bir metindir.

Sahada duran bu üç kaydın ortak kuralı şu: kısa olacak, tarihli olacak ve dijital kaydıyla çelişmeyecek. Çeliştiği anda sahadaki kâğıt kazanır, çünkü oradaki kişi ona bakar.

BT Dokümantasyonu Nerede Tutulur?

Doğru yer, ekibin fiilen açtığı yerdir. Araç seçimi bu sorunun cevabından sonra gelir ve üç şart sağlandıktan sonra araçlar arasındaki fark hızla küçülür: arama çalışmalı, sürüm geçmişi tutulmalı ve erişimi olan herkes yazabilmeli.

Üçüncü şart en çok direnç görenidir. Yazma yetkisini tek kişide toplamak kaydı temiz tutar gibi görünür, ama pratikte kaydı durdurur: bilgiyi olan kişi yazamaz, yazabilen kişi bilmez. Taşı bir kişi oyabilir, ama ne yazılacağını seferden dönen herkes bilir.

Pratikte üç yer birlikte kullanılıyor ve birbirinin yerine geçmiyor:

  • Wiki ya da paylaşılan not sistemi: yordamlar, kararlar ve gerekçeler. Metnin doğal yeri burasıdır.
  • Envanter sistemi: cihaz ve lisans kayıtları. Elle tutulan bir tablodan farkı, kaydın cihazın kendisinden toplanmasıdır.
  • Parola kasası: credential’lar (kimlik bilgileri) ve yalnız onlar. Dokümantasyon kasaya işaret eder, içeriğini kopyalamaz.

Ağ cihazlarının yapılandırma dosyaları ise dördüncü bir yerde, düzenli olarak alınan yedeklerde durur; o yedeğin nasıl ve nereye alındığı TFTP ile yapılandırma yedeği yazımızın konusu.

Dokümantasyonu Güncel Tutan Nedir?

Benzetmenin koptuğu yer burası ve kopma noktası tam da işin en zor yarısı. Orhun Yazıtları bir kez kazındı ve bin üç yüz yıl boyunca aynı şeyi söylemeye devam etti; değeri değişmezliğinden geliyor. BT dokümantasyonu tam tersidir: sistem her hafta değişir ve değişimi takip etmeyen kayıt bir süre sonra yanlış bilgi vermeye başlar. Eski dokümantasyon, hiç dokümantasyon olmamasından tehlikelidir, çünkü okuyan kişi ona güvenerek karar verir.

Güncelliği sağlayan şey disiplin çağrısı değil, kaydın işin akışına bağlanmasıdır. Üç bağ pratikte tutuyor:

  1. Değişiklik kaydı, işin bitiş adımıdır. Bir yapılandırma değişikliği, kaydı yazılmadan tamamlanmış sayılmaz. Ayrı bir görev olarak takvime konan dokümantasyon ilk yoğun haftada düşer; işin son adımı olarak tanımlanan dokümantasyon düşmez.
  2. Belge, kullanıldığı yerde durur. Kimsenin girmediği bir klasördeki dosya güncellenmez. Ekip hangi aracı zaten açıyorsa kayıt oraya taşınır; alışkanlığı belgeye değil, belgeyi alışkanlığa uydurmak gerekir.
  3. Yılda bir doğrulama turu yapılır. Envanterdeki cihazların hâlâ orada olduğu, yordamların hâlâ çalıştığı ve erişim kayıtlarının hâlâ geçerli olduğu kısa bir turla kontrol edilir. Bu tur bir denetim değil, bakımdır.

Burada bir ayrım şart, çünkü her okunmayan belge ölü değildir. Bazı kayıtlar zaten hiç açılmamak için yazılır: felaket anında izlenecek adımlar, yedekten dönüş yordamı, sistem çöktüğünde aranacak kişi. Bunlara bakmak zorunda kalmamak iyi haberdir. Bir binanın yangın söndürme sistemi de ömrü boyunca hiç devreye girmeyebilir; bu, sistemi kurmamanın gerekçesi olmaz. Yangının çıkıp çıkmayacağını önceden bilemediğimiz için önlemi çıkacakmış gibi alırız. Bu makalenin taşı da yüzyıllarca bozkırda kimse okumadan durdu ve değerini kaybetmedi, yalnızca okunacağı günü bekledi.

Ölçüt bu yüzden “bakılıyor mu?” değil, “bakılması gerektiğinde bulunur ve işe yarar mı?” olmalı. İkisi farklı kayıt türüne düşüyor:

  • Günlük işin içinde olması gereken kayıt (yordam, adresleme planı, envanter) kimse açmadan iş görülebiliyorsa gerçekten sorunludur. Orada sorulacak soru neden bakılmadığıdır; cevap genellikle yerinin ya da biçiminin yanlış olmasıdır.
  • Sigorta niteliğindeki kayıt (felaket yordamı, acil iletişim, geri dönüş adımları) kullanım sıklığıyla denetlenmez, tatbikatla denetlenir. Yılda bir kez okunup çalıştığı denenmiyorsa, o belge kullanıldığı gün ilk kez sınanacak demektir ve sınanacağı gün de tam olarak sınanmaması gereken gündür.

Dokümantasyonun bir denetim yükümlülüğüne dönüştüğü yerde iş ayrıca ciddileşir: belgelendirme süreçlerinde istenen şey tedbirin alınmış olması değil, alındığının gösterilebilmesidir. Kanıtlanamayan tedbir alınmamış sayılır ve bu, ISO 27001 danışmanlığı tarafında en çok zaman alan kalemdir.

Dokümantasyonun Zor Yanı Teknik Değil, İnsan

Buraya kadarki her şey yöntemdi; neyin yazılacağını, nerede duracağını ve nasıl güncel kalacağını konuştuk. Sahada bu yöntemin takıldığı yer ise neredeyse hiç teknik olmuyor. İki direnç var ve ikisi de insana ait.

İnsanlar Bildiklerini Yazmak İstemez

Bir ekibe “bildiklerinizi yazın” demek, dokümantasyonun başladığı an değildir; çoğu zaman hiçbir şeyin başlamadığı andır. Yazılmaz. Yazılırsa eksik yazılır. Bazen bilerek kötü yazılır, çünkü kötü yazılmış bir belge o işten kurtulmanın en sessiz yoludur.

Bunun bir kısmı üşenmektir, ama tamamı değil. Bilgisini yazıya döken kişi, kurumdaki yerini tarif eden şeyi de yazıya dökmüş olur. Kimsenin açıkça söylemediği hesap şudur: bu kayıt tamamlandığında ben hâlâ gerekli miyim? Soru dile getirilmediği sürece de cevaplanamaz; ekip yazmaz, yönetim ısrar eder, iş uzar.

Buradan çıkan pratik sonuç şu: dokümantasyon bir kültür meselesiyse, kültürün en ucuz kurulduğu an işe alım anıdır. Mevcut ekipte kurmak imkânsız değil ama başka bir iş: orada kaygıyı adlandırmak, kimsenin yerinin yazdığı belgeyle tehdit altında olmadığını açıkça söylemek ve ilk kaydı yöneticinin kendisinin yazması gerekir.

İnsanlar Yazılanı Okumak İstemez

İkinci direnç okuma tarafında ve burada iyi haber yok: yazdığınız belge, yazıldığı için okunmaz. Nielsen Norman Group’un göz izleme çalışmaları web sayfalarında ölçülen davranışı net gösteriyor, okurların %79’u sayfayı tarıyor, yalnız %16’sı satır satır okuyor (layer-cake deseni). Kurumsal bir wiki’nin bundan muaf olması için bir sebep yok; tersine, orada okuyan kişi çoğu zaman bir arıza anında panik hâlindedir ve işi aceledir.

Sahada bunun karşılığı tanıdıktır: kimse arşivi açmaz, herkes bilen kişiyi arar. Telefon açmak, otuz sayfalık bir belgede doğru paragrafı aramaktan hızlıdır ve insan her zaman hızlı olanı seçer.

Bu, belgeyi yazan kişinin suçu değil ama çözümü de o tarafta. Okunmayan bir dokümantasyonun cevabı ekibi suçlamak değil, belgeyi taranabilir hale getirmektir:

  • Başlık haritası düzgün kurulur. Bir belgenin başlıkları tek başına okunduğunda konunun tamamını anlatmalı; tarayan kişi gövdeye ancak doğru başlığı bulduğunda iner.
  • Uzun anlatım listeye döner. Sırayla yapılacak işler numaralı listeye, seçenekler madde işaretine, karşılaştırmalar tabloya girer. Üç aşamadan uzun bir paragraf zaten bir listedir.
  • Şema, paragrafın yapamadığını yapar. Neyin neye bağlı olduğunu, bir akışın hangi sırayla işlediğini ve bir kararın hangi koşulda değiştiğini anlatan yerlerde bir çizim, üç paragraftan fazla iş görür.
  • Aranabilirlik ciddiye alınır. İnsanlar başlığı değil, akıllarında kalan kelimeyi arar. Cihaz adı, hata mesajı ve komut belgenin içinde geçmeli ki arama onları bulsun.

Bunların hiçbiri belgeyi daha doğru yapmaz, yalnız bulunabilir yapar. Ama bir kaydın bulunamaması ile hiç yazılmamış olması arasında, onu arayan kişi açısından bir fark yoktur.

Sıfırdan Başlıyorsanız İlk Üç Adım

Hiç dokümantasyonu olmayan bir kurumda en yaygın hata, en baştan başlamaya çalışmaktır. Kapsam büyük göründüğü için iş hiç başlamaz. Sıra şöyle kurulursa ilk hafta içinde elle tutulur bir şey çıkar:

  1. Tek kişide duran bilgiyi yazın. Kurumda yalnız bir kişinin bildiği ne varsa, önce o. Bu adım en az zaman alan ve en çok riski kapatan adımdır; hangi bilginin bu tarife girdiğini bulmanın yolu da basittir, ekibe “yarın izne çıksanız hangi işi kimse yapamaz” diye sorun.
  2. Envanteri çıkarın. Neyin var olduğunu bilmeden geri kalan hiçbir katman kurulamaz. Eksiksiz olması gerekmez, başlamış olması gerekir.
  3. Bir sonraki değişikliği yazarak yapın. Geriye dönük her şeyi belgelemeye çalışmak yerine, bugünden sonraki her değişikliği kaydederek ilerleyin. Geriye dönük borç zamanla kapanır, ileriye dönük borç kapanmaz.

Bu üçünün ortak yanı, hiçbirinin bir araç kurulumuna bağlı olmamasıdır. Araç kararı bekleyen bir kurum genellikle o kararı hiç vermez; oysa üç adımın üçü de bir metin dosyasıyla başlatılabilir.

Sonuç: Dokümantasyonun Değeri Yazan Gittiğinde Çıkar

Dokümantasyon, bir kurumun bilgisini kişilerden kuruma taşıma işidir ve değeri yazıldığı gün değil, yazan kişi orada olmadığı gün ortaya çıkar. Karşılığını çoğu zaman görmezsiniz: kaydınızı açan kişi sizi tanımayacak, teşekkür de etmeyecek.

O taş dikilirken de durum farklı değildi. Sekizinci yüzyılda bozkırda okuma yazma bilen çok az insan varken devasa bir kayaya aylarca harf kazımak, dışarıdan bakana kağanın boş işi gibi görünmüş olmalı. Karşılığını vermesi bin yıldan uzun sürdü: yazıtlar on dokuzuncu yüzyılın sonunda çözüldüğünde ortaya bir zafer listesi değil bir yönetim kaydı çıktı. Yazılı öğüt bırakma fikri de o taşla geldi; Gençliğe Hitabe’yi aynı zincirin çok sonraki bir halkası olarak okumak mümkün.

Sizin kaydınızın ömrü o kadar uzun olmayacak. Ama direnci aynı: bunun boş iş olduğunu söyleyen biri mutlaka çıkar. Doğru olanı yapmaktan şaşmayın.

O gün sorulacak soru da tek olur: bu böyle neden yapılmış?

Cevabı bugün yazacak olan sizsiniz.

BT dokümantasyonunun iki çağı yan yana: solda bozkırda taşa kayıt kazıyan usta, sağda sistem odasında kabinetin yanına çerçeveli yerleşim şemasını asan BT çalışanı
Yüzey değişti, yüzyıl değişti, jest aynı kaldı: birileri kendinden sonra gelecek kişi için okunacak bir kayıt bırakıyor.

Bu yazıyı; gündüz oturmayan, gece uyumayan, milleti için ölesiye bitesiye çalışan ve yurtta sulh cihanda sulh diyerek dünyaya gözlerini yuman sayısız kahraman atamıza armağan ediyoruz. Huzur içinde uyuyun.

BT Dokümantasyonu Hakkında Sık Sorulan Sorular

Parola dokümantasyona yazılmaz, parola kasasına yazılır ve dokümantasyon o kasaya işaret eder. Ayrım şu: dokümantasyon bir sistemin nasıl çalıştığını anlatır ve okunması için nispeten geniş bir kitleye açıktır; kasa ise tek tek erişim verilen, her açılışı kaydedilen ayrı bir yerdir. Pratikte yazdığımız cümle şu biçimde olur: bu cihazın yönetici hesabı şu isimdedir ve parolası kasada şu kayıtta durur. Böylece devralan kişi hem hesabın varlığını bilir hem parolayı hak ettiği yerden alır. Dokümantasyona düz metin parola yazmak, o dosyayı okuyabilen herkese yönetici yetkisi vermektir.
İşi yapan yazar, ayrı bir yazar tutmak çoğu kurumda işe yaramaz. Sebebi şu: dokümantasyonun değerli kısmı adımlar değil gerekçelerdir ve gerekçe yalnız kararı verende bulunur. Dışarıdan biri neyin nasıl yapıldığını kaydedebilir ama neden öyle yapıldığını kaydedemez. Bizim işlerimizde kayıt işin kendisiyle birlikte yürür: bir yapılandırma değiştiğinde o değişikliğin kaydı da aynı gün yazılır, ay sonuna bırakılmaz. Ay sonuna bırakılan kayıt yazılmaz, yazılırsa da eksik yazılır.
Yeter, ama üç şartla: arama çalışacak, sürüm geçmişi tutulacak ve erişimi olan herkes yazabilecek. Bir klasördeki Word dosyaları ilk şartta genellikle kalır, çünkü aranan şey dosya adında değil dosyanın içindedir. Asıl ayrım araçta değil alışkanlıkta: düzenli güncellenen bir klasör, kimsenin yazmadığı bir wiki'den iyidir. Küçük bir kurumda klasörle başlamak doğru karardır; wiki'ye geçiş, arama ve eş zamanlı düzenleme sıkıntı vermeye başladığında gündeme gelir.
Güncelliği hatırlatma değil, işin akışına bağlama sağlar. Üç bağ işe yarıyor: değişiklik kaydını işin bitiş adımı saymak, dokümantasyonu fiilen kullanılan yere koymak ve yılda bir kez kısa bir doğrulama turu yapmak. Bunların ortak noktası, dokümantasyona ayrı bir zaman ayırmamalarıdır. Ayrı zaman isteyen her yöntem ilk yoğun haftada düşer. Ölçüt kullanım sıklığı değildir, çünkü bazı kayıtlar zaten hiç açılmamak için yazılır: felaket yordamı gibi. Ayrım şu: günlük işin içinde olması gereken bir belgeye kimse bakmadan iş görülebiliyorsa orada bir sorun vardır ve sorulacak soru neden bakılmadığıdır, cevap genellikle yerinin ya da biçiminin yanlış olmasıdır. Sigorta niteliğindeki kayıtlar ise kullanım sıklığıyla değil tatbikatla denetlenir; yılda bir kez okunup çalıştığı denenmiyorsa o belge kullanıldığı gün ilk kez sınanacak demektir.
İlker Pehlivan
Yazan

BT Danışmanı | Ağ, Sistem ve Güvenlik Yönetimi

İlker Pehlivan, karmaşık BT altyapılarını ölçeklenebilir ve güvenli sistemlere dönüştürür. Buradaki rehberleri kendi laboratuvarında kurup ölçerek yazar.

LinkedIn

Benzer Makaleler

BT Danışmanlık altındaki diğer 11 makale