Belgelemeli mi? Belgelememeli mi?
"Söz uçar yazı kalır…"
Aslında “belgelemek” ifadesini kullanırken tereddütlüyüm biraz. Çünkü Türkçede “belgelemek” kavramı daha çok sertifikalamak, geçerliliğini ispat etmek anlamında kullanılıyor. Benim kastetmek istediğim anlamıysa bir şeyleri arşivleme amaçlı olarak belgelere kaydetmek, kayıt altına almak.
Tek başınıza çalışıyorsanız ya da küçük bir ekiple işi yapıyorsanız en çok sıkıntı duyulan bir başlık da dokümantasyon, yani belgelemedir. Normalinde müşteriyle ilk görüşmeden, ilk toplantıdan başlayarak, projenin teslimine kadar sürekli olarak devam edecek bir süreç olan belgeleme, maalesef ülkemizde yazılı iletişim kültürünün zayıf oluşu, söze itimadın ön planda kalışı gibi nedenlerle ikinci plana atılmaktadır. Aslında belki her iki tarafın da yazılı taahhütler, tutanaklar altına imza atmaktan çekinmesini de bu nedenler arasına ekleyebiliriz.
Yazılı çalışmak bir disiplin gerektirir ve hem zaman olarak hem de kaynak ayırmak gerekliliği nedeniyle bir maliyeti vardır. Ancak toplamda getiri ve götürülerine bakıldığında yazılı çalışmanın açık ara kazançlı olduğunu göreceksiniz.
Yazılı çalışmak sizin için, kendi açınızdan önemlidir. Birden çok projeyle çalıştığınızda, büyük projelerde, projenin üzerinde uzunca bir zaman geçtiğinde mutlaka proje hakkında, kod hakkında açıklamalara ihtiyaç duyarsınız. Verinin nasıl tutulacağıyla ilgili yapısal tasarım bilgilerine, kodlamada hangi algoritmaları hangi amaçla yaptığınıza ihtiyacınız olur. Hele ki bir ekiple çalışıyorsanız ya da başka birinin yazdığı kodun bakımını yapıyorsanız ve açıklama satırları/belgeleri yoksa düşünün halinizi.
Yazılı çalışmak müşteri için önemlidir, güven verir. Her ne kadar sizi taahhüt altına alsa da, yapacağınız işleri yazılı olarak verdiğinizde ve tarihlendirdiğinizde müşteriyi disiplin ve profesyonelliğinizle etkilersiniz. Proje boyunca raporlama ve proje tesliminde projenin tamamına ait detaylı bir belge teslimi, müşterinizi fazlasıyla memnun edecektir. Müşteri böylece projenin bakımı konusunda kendini güvende hisseder
Her iki taraf için de proje sözleşmesi de dahil olmak üzere toplantıları karşılıklı imzalarla tutanak altına almak, bilgi aktarımlarını yazılı ortamlar üzerinden mümkün olan en detaylı ve açık biçimde yapmak proje bitiminde mutlu bir sonun alt yapısını hazırlayacaktır.
“Ben size “şöyle şöyle” dedim ama kastettiğim “böyle böyle” bir şeydi.”
(Müşteri)
“Biz yazılımda böyle bir ekran istemiyorduk ama!” (Müşteri)
“Yaa patron bu kodu çözemiyorum bir türlü, yeniden yazayım ben yaa.”
(Başkasının kodunda güncelleme yapan bahtsız yazılımcı.)
“Tabii ki uygulamayı aslında geçen hafta teslim etmemiz gerekiyordu fakat…”
(Proje yöneticisi)
Yukarıdaki diyalogları ya bizzat yaşamışsınızdır ya da mutlaka şahit olmuşsunuzdur. Peki bu tip diyalogları en aza indirmek için ne yapmak gerekir? Tabii ki mümkün olduğunca yazılı çalışmaya dikkat etmek, yapılanları belgelemek gerekir.
Peki neleri belgelemeliyiz?
En başta projeyi alışınızla birlikte ilk yapmanız gereken bir proje/ürün tanımı oluşturup, ardından proje ekibi ve kaynaklarını belirleyerek proje planını yapmaktır. Tabii bunların hepsinin yazılı olması en iyisidir.
İletişimi, bilgi alış verişini belgelemeliyiz. Müşteriden gelecek bilgiler belirli bir adrese, daha önceden belirlenmiş bir biçimde gelmeli ve düzenli olarak kayıt edilmeli.
Toplantılar mutlaka tutanakla belgelenmeli ve hatta tutanak herkese okutularak imza alınmalı ki sonradan itirazlar gelmesin.
Yazılım isterleri çözümleme aşaması, isterler, analiz; uygulama mimarisi ve tasarımı, veritabanı yapısı; kodlama ve arayüz taslakları; kod içindeki açıklamalar ve proje türünüze göre daha başka birçok şey…
Sonuçta yazacağınız her satır vaktinizi alacak ama sonrasında ihtiyacınız olduğunuzda kolayca ulaşılabilir olmasını sağlayacaktır. Neleri belgeleyeceğinizi belirlerken bir kıstas olarak en basitinden şunu uygulayabilirsiniz:
Kendinize sorun:
“Daha sonra ben bu projeyi birine devretsem ve bana hiçbir şekilde soru sormadan, sadece hazırladığım belgelerle iş yapacak olsa en az neleri belgelemem gerekir?”
Yeterince ikna olduysanız, her bir proje için bir proje dosyası açmanız gerektiğini farketmişsinizdir. Böylelikle projeyle ilgili tüm belgeler tek bir yerde toplanacak ve değişikliklerin takibi kolay olacaktır. Proje dosyasına proje başlatma belgesi, sözleşme, proje planı, diğer planlar (risk, satınalma vb.), sistem tanımı, tasarım belgeleri, kodlama vb. standartları, tutanaklar ve her türlü yazışmayı ekleyin.
“Söz uçar yazı kalır”
Kadir Çamoğlu
Ortam sanal olsa da, islenen suc gercektir...
|
Del.icio.us
Digg
Facebook
Furl
Google
Blink
Simpy
Spurl
Y! MyWeb