BT Danışmanlık

Teknik Rapor Nasıl Yazılır? Yöneticinin Okuyacağı Dil

Teknik rapor nasıl yazılır: kararı ilk sayfaya koyan yapı, BT ihtiyacını risk, para, süre ve seçenek diliyle anlatmak, bulgu kalıbı ve kontrol listesi.

İlker Pehlivan

Teknik rapor, teknik bir incelemenin sonucunu karar verecek kişinin anlayacağı dille yazan belgedir. BT’de bu kişi çoğu zaman bir genel müdür, bir finans yöneticisi ya da şirket sahibidir ve sunucuyu, ağı ya da yedeklemeyi bilmek zorunda değildir. Bu yüzden iyi bir teknik raporu teknik doğruluğu değil, okurunun verdiği karar ölçer.

BT altyapı denetimi sayfamızda denetimi bir ev ekspertizine benzetmiştik. Eksper evi gezer, duvardaki çatlağın taşıyıcıda mı sıvada mı olduğunu ayırır ve raporunda önce nemin, sonra boyanın yapılması gerektiğini yazar. Raporu okuyan kişi ise inşaattan anlamaz, yalnız evi alıp almayacağına ve pazarlıkta neyi soracağına karar verir. Eksper raporunu o kişiye yazar, bir inşaat mühendisine değil.

Satılık boş bir evin salonunda pencerenin önündeki ahşap masada zeytin yeşili ceketli eksper, elindeki raporun ilk sayfasını parmağıyla gösteriyor, lacivert paltolu ev alıcısı eğilip dinliyor, arkadaki sıva duvarda ince çatlaklar var
Eksper raporunu inşaattan anlamayan ev alıcısına anlatır ve önce kararı gösterir. Teknik rapor da BT'yi bilmeyen karar vericiye yazılır, karar ilk sayfadadır.

Bu yazı, denetimde ya da günlük işte bulduğunuz bir BT ihtiyacını yönetime nasıl yazacağınızı anlatıyor: raporun yapısı, teknik ihtiyacın karar dili, tek bir bulgunun nasıl yazıldığı ve göndermeden önce bakılacaklar.

Teknik Rapor Kimin İçin Yazılır? İki Okur

Teknik raporun iki okuru vardır ve ikisi aynı soruyu sormaz. Karar verici, ne olursa ne kaybedileceğini, düzeltmenin ne kadar tutacağını ve ne zaman biteceğini sorar. Uygulayıcı ise tam olarak neyin bozuk olduğunu ve nasıl düzeltileceğini sorar. İki soruyu aynı paragrafta cevaplamaya çalışan rapor, ikisini de yarım bırakır.

Çözüm, raporu iki katmanda yazmaktır. İlk katman karar vericinindir ve ilk sayfada biter. İkinci katman uygulayıcınındır ve bulgularla ekte durur. Karar verici ilk sayfadan sonra okumayı bırakabilir, uygulayıcı ise ilk sayfayı atlayıp doğrudan bulgulara gidebilir. İkisi de aradığını bulur.

Örnekteki eksper raporu da böyle kurulur. İlk sayfada “ev alınabilir, ama çatıdaki su yalıtımı yapılmadan alınmamalı” yazar. Çatı kaplamasının malzemesi ve ölçüsü ise arkadaki sayfalardadır, ustanın okuyacağı yerde.

Teknik Raporun Yapısı: Karar İlk Sayfada

Teknik raporun yapısı tek bir ilkeye dayanır: sonuç başa yazılır. Kullanıcı deneyimi araştırma şirketi Nielsen Norman Group bu düzene ters piramit diyor. Bu düzende en önemli bilgi, hatta sonuç, ilk sırada verilir ve okur nerede bırakırsa bıraksın ana fikri almış olur. Bir teknik rapor dört bölümden oluşur:

BölümOkuruCevapladığı soruUzunluk
Yönetici özetiKarar vericiNe bulundu, ne öneriyoruz, ne kadar tutar, ne kadar sürer?Tek sayfa
BulgularKarar verici ve uygulayıcıHer sorun ne, neden önemli, önceliği ne?Bulgu başına yarım sayfa
ÖnerilerKarar vericiHangi seçenekler var, hiçbir şey yapmazsak ne olur?Seçenek başına bir paragraf
EkUygulayıcıEnvanter, komut çıktısı, ekran görüntüsü, ayrıntılı ölçümGerektiği kadar

En sık yapılan yanlış, raporun inceleme sırasıyla yazılmasıdır: önce ne yapıldığı, sonra ne bulunduğu, en sonda ne önerildiği. Bu sıra yazara doğal gelir, çünkü yazar işi o sırayla yaşamıştır. Okur ise kararın sayfa sekizde olduğunu bilmez ve oraya hiç varmayabilir.

Yönetici özeti raporun en kısa ve en zor bölümüdür. Raporun geri kalanı yazıldıktan sonra yazılır, çünkü ancak o zaman neyin önemli olduğu bellidir.

BT İhtiyacını Teknik Olmayan Karar Vericiye Anlatmak

BT ihtiyacı karar vericiye teknik terimle değil, onun zaten kullandığı dört kavramla anlatılır: risk, para, süre ve seçenek. Bir genel müdür sunucunun ne olduğunu bilmeyebilir, ama bir makinenin durursa üretimi durduracağını, bir harcamanın kaça mal olacağını ve bir işin ne zaman biteceğini sorarak karar verir. Rapor bu dört soruya cevap verdiğinde teknik terime gerek kalmaz.

Teknik terimi bilen biri, onu bilmeyen birinin yerine kendini koymakta zorlanır. Bu zorluğun bir adı var ve onu uzmanlık laneti yazımızda anlattık. Aşağıdaki dört dil, o laneti raporda telafi etmenin yoludur.

Risk Dili: Olursa Ne Kaybedilir?

Risk, bir olayın gerçekleşme olasılığı ile gerçekleşirse yaratacağı zararın birlikte ölçüsüdür. ABD’nin standartlar kurumu NIST, risk tanımını bu iki parçaya dayandırır. Raporda ikisi de karar vericinin anlayacağı biçimde yazılır: zarar bir iş sonucu olarak, olasılık da bir gerekçeyle.

Teknik cümle şöyledir: “Domain controller tek, FSMO rolleri ve DNS aynı sunucuda.” Karar vericinin cümlesi ise şöyle: “Şirkette herkesin oturum açmasını sağlayan sistem tek bir sunucuya bağlı. O sunucu bozulursa kimse bilgisayarına ve e-postasına giremez. Sunucu yedi yaşında ve disklerinden biri hata veriyor.” İkinci cümle aynı bulguyu zararıyla ve olasılığıyla anlatır.

Para Dili: Ne Kadar Tutar, Ne Kadar Kaybettirir?

Bir BT harcaması tek başına sorulmaz, karşılaştırılarak sorulur. Karar verici, ikinci bir sunucunun ne kadar tutacağının yanında, ilk sunucu bozulursa bir günün kaça mal olacağını da görmek ister. Bu yüzden rapor iki rakam taşır: düzeltmenin maliyeti ve düzeltmemenin olası maliyeti.

Düzeltmemenin maliyeti kurumun kendi rakamlarıyla hesaplanır, internetteki ortalamalarla değil. En basit hesap, işini yapamayan kişi sayısı ile kesinti süresinin ve bir saatlik iş değerinin çarpımıdır. Rakam kesin olmak zorunda değildir, ama nereden geldiği yazılmalıdır, çünkü karar verici ilk olarak o rakamı sorgular.

Süre Dili: Ne Zaman Biter, Kesinti Olur mu?

Karar vericinin üçüncü sorusu süredir. İşin ne kadar süreceğini, bu sürede çalışanların etkilenip etkilenmeyeceğini ve en geç ne zamana kadar yapılması gerektiğini bilmek ister. “Kurulum iki gün sürer, kullanıcılar etkilenmez, geçiş bir cumartesi akşamı yarım saatlik bir kesintiyle yapılır” cümlesi, karar vericinin takvimine oturur.

Süre dilinin bir yanı da son tarihtir. Bir yazılımın destek süresi bitiyorsa ya da bir lisans yenilenecekse, rapordaki tarih kararı kendiliğinden hızlandırır. Tarih yoksa öneri “bir ara yapılır” listesine girer.

Seçenek Dili: Hiçbir Şey Yapmamak da Bir Seçenektir

Karar vericiye tek bir öneri götüren rapor, ona evet ya da hayır demekten başka bir yol bırakmaz. İyi bir rapor iki ya da üç seçenek sunar ve bunlardan biri her zaman “hiçbir şey yapmamak”tır. Hiçbir şey yapmamanın sonucu açıkça yazıldığında, karar verici riski bilerek üstlenmiş olur.

SeçenekMaliyetSüreKalan risk
Hiçbir şey yapmamakYokYokSunucu bozulursa bir gün ya da daha uzun süre kimse oturum açamaz
Mevcut sunucunun diskini değiştirmekDüşükYarım günTek sunucu riski sürer, yalnız disk arızası olasılığı azalır
İkinci bir sunucu kurmakOrtaİki günSunuculardan biri bozulursa öbürü işi sürdürür

Örnekteki eksper de “bu evi alın” demez. Çatı yalıtılırsa evin sorunsuz olacağını, yalıtılmazsa iki kışta tavanda leke çıkacağını yazar. Kararı ev alıcısı verir, ama artık neyi bilerek verdiğini bilir.

Teknik Raporda Bulgu Nasıl Yazılır?

Teknik raporda her bulgu aynı dört parçayla yazılır: ne gördük, neden önemli, ne öneriyoruz ve önceliği ne. Bu kalıp, karar vericinin her bulguda aynı yere bakmasını sağlar ve iki bulguyu karşılaştırmayı kolaylaştırır. Bizim denetim raporlarımızda kullandığımız kalıp şöyle:

  1. Ne gördük: olgu, yorumsuz. “Sunucuların yedeği her gece alınıyor, ama son geri yükleme denemesi kayıtlarda yok.”
  2. Neden önemli: zarar ve olasılık. “Yedekten geri dönülemezse, bir fidye yazılımı saldırısında veri kurtarılamaz.”
  3. Ne öneriyoruz: eylem, maliyet ve süre. “Bir sunucunun yedeği ayrı bir makineye geri yüklenip açılsın. Yarım günlük iş, ek maliyeti yok.”
  4. Öncelik: sıra ve gerekçe. “Yüksek, çünkü diğer bütün güvenlik önlemleri bu yedeğe dayanıyor.”

Kalıbın en çok atlanan parçası ikincisidir. “Yedek denenmemiş” bir olgudur, ama karar verici bunun neden önemli olduğunu kendi başına çıkaramaz. Olgu ile karar arasındaki köprüyü rapor kurar.

Bulguların sırası raporun kendisi kadar önemlidir. Karar verici çoğu zaman listenin ilk üç maddesine karar verir, gerisini sonraki bütçeye bırakır.

Teknik Raporu Göndermeden Önce: Kontrol Listesi

Teknik rapor yazıldıktan sonra bir kez de karar vericinin gözüyle okunur. Aşağıdaki sorular o okumanın kontrol listesidir:

  • Karar ilk sayfada mı? Yönetici özetini okuyan biri, raporun geri kalanını açmadan ne önerildiğini ve ne kadar tuttuğunu söyleyebilmeli.
  • Her teknik terimin yerine sonucu yazıldı mı? Yönetici özetinde ve önerilerde kalan her terim, karar vericinin bir sonraki cümleyi de kaçırması demektir.
  • Her bulgunun bir önceliği var mı? Öncelik bir sıra olmalı, herkese “yüksek” yazılmamalı.
  • Her rakamın kaynağı yazılı mı? Kesinti maliyeti de, cihaz fiyatı da nereden geldiğini söylemeli.
  • “Hiçbir şey yapmazsak” seçeneği var mı? Karar verici riski bilerek üstlenebilmeli.
  • Bir tarih var mı? Destek sonu, lisans yenilemesi ya da önerilen başlangıç tarihi kararı takvime bağlar.
  • Konuyu bilmeyen biri okudu mu? Rapordan anlamadığı tek bir cümleyi işaretlemesi, yazarın göremediği yeri gösterir.

Son madde listenin en etkilisidir. Yazar kendi raporunda takılacak yeri göremez, çünkü konuyu bilmektedir. Konuyu bilmeyen bir okur ise o yeri ilk okumada bulur.

Sonuç: Teknik Raporun Ölçüsü Okurun Verdiği Karardır

Teknik raporun ölçüsü, okurunun verdiği karardır. Kararı ilk sayfaya koyan, BT ihtiyacını risk, para, süre ve seçenek diliyle anlatan ve her bulguyu aynı kalıpla yazan bir rapor, okuru inşaattan anlamasa da ona bir karar verdirir. Bu konuda beklenenden farklı olan üç şey var:

  • Raporun en zor bölümü en kısa olanıdır: yönetici özeti en son yazılır.
  • Hiçbir şey yapmamak da bir seçenektir ve raporda yazılı olmalıdır.
  • Her bulguyu kritik diye işaretlemek riski büyütmez, raporun güvenilirliğini düşürür.

Girişteki benzetmeye dönersek: eksperin raporu, ev alıcısı onu okuyup pazarlık masasına oturduğunda işini yapmış olur. Örnekteki çatı yalıtımı, raporunuzdaki ilk bulgudur, arkadaki malzeme listesi de eki. Raporun kurum içinde kalıcı olması için bulgular ve kararlar BT dokümantasyonuna işlenir, aksi halde aynı tespit iki yıl sonra yeniden yapılır.

Teknik Rapor Yazma Hakkında Sık Sorulan Sorular

Sayfa sayısından çok ilk sayfa önemlidir. Karar vericinin okuyacağı yönetici özeti tek sayfayı geçmemelidir: ne bulundu, ne öneriliyor, ne kadar tutar ve ne kadar sürer. Teknik ayrıntı, envanter ve komut çıktıları eke gider ve ek istediği kadar uzun olabilir.
Aynı şey değildir. Giriş raporun neyi kapsadığını anlatır, yönetici özeti ise raporun sonucunu verir. Yönetici özetini okuyup raporun geri kalanını hiç açmayan bir yönetici, yine de kararını verebilmelidir.
Kullanılabilir, ama yönetici özetinde değil. Karar vericiye giden bölümde terimin yerine sonucu yazılır: 'replikasyon hatası' değil 'iki sunucudan biri bozulursa kullanıcılar oturum açamaz'. Uygulayıcıya giden bulgular ve ek bölümünde teknik terim doğru ve gereklidir.
Değildir. Her bulgu kritik olarak işaretlenirse karar verici hangisinin önce yapılacağını ayıramaz ve raporun geri kalanına da güvenmez. Öncelik bir sıradır: en fazla birkaç bulgu en üstte durur, gerisi sıraya girer.
İ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 Altyapı Denetimi: Envanter, Risk ve Yol Haritası

BT altyapı denetimi: cihaz ve sistem envanterinin çıkarılması, yedeklilik ve güvenlik risklerinin tespiti, önceliklendirilmiş yol haritası ve yönetime rapor.

8 dk okuma

Postmaster Nedir? Kurumda Olması Gereken Rol Adresleri

Postmaster nedir: SMTP standardının zorunlu tuttuğu postmaster@ adresi. Abuse, hostmaster ve security adresleri, hangisi gerekli ve gruba nasıl bağlanır.

11 dk okuma

BT Danışmanı Nedir? Ne Yapar, Nasıl Seçilir?

BT danışmanı nedir: kurumun BT altyapısını inceleyip yatırım ve öncelik kararlarında tarafsız görüş veren uzman. Ne yapar, ne zaman gerekir ve nasıl seçilir.

4 dk okuma

İş Sürekliliği Planı Nedir? BT İçin Nasıl Hazırlanır

İş sürekliliği planı nedir: bir kesintide işin nasıl süreceğini önceden yazan plan. Felaket kurtarmadan farkı, iş etki analizi, planın içeriği ve tatbikatı.

5 dk okuma

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.

15 dk okuma

Shadow IT (Gölge BT) Nedir? Riskleri ve Tespiti

Shadow IT (Gölge BT) nedir, neden doğar, nasıl tespit edilir? Onaysız uygulamaların riskleri, gölge kavramlarının ayrımı ve envanterden başlayan keşif yöntemi.

28 dk okuma