Yazılımcıların dokümantasyon kültürünü nasıl kullanıyorum?


Yazılımcı değilim. Bir ara fırsatını buldum ama fıtrattan kaynaklı olduğunu düşündüğümden dolayı olmadım diyebilirim. Çok küçükken bir bilgisayarım olsaydı şu an ne yapıyor olurdum onu bilmiyorum. Yıllar önce böyle demişti yazılımcı bir arkadaşım: “Fıtratın neye meyilli ise o işi yapıyorsun, bizim işler böyle. Ya tasarımcı olursun, ya yazılımcı.” Yazılımdan hiç bir zaman kopmadan tasarımcılıkla başladım işe. Belki yaşım yazılım için geçti, belki de gözüm korktu. Bir ara PHP çalıştım, belli başlı şeyleri öğrendim ama ilerletemedim. İçerik yönetim sistemi olan WordPress’i iyi düzeyde kullanacak kadar bilgiyi edindim en azından. O günlerden bu yana yazılımcıların çalışma sistemlerine hem hayranlık hem de saygı duyarım.

Gün geldi, devir döndü kendimi bu işlerin çok dışındaymış gibi görünebilecek ama bunun tam tersini de düşündüğüm editörlük işinde buldum. Bana göre bu iş edebiyatla ilgili olduğu kadar içinde matematik ve analitik düşünce gerektiren bir iş aynı zamanda. Bu ayrı bir yazının konusu.

Başka bir yazının konusu da şu: Ortaokul sıralarında edebiyattan nefret eden, liseden fen bilimleri bölümünden mezun olan, bilgisayar ve öğretim teknolojisi öğretmenliği okuyan, aldığı eğitim neredeyse tamamen sayısal olan biri ilerleyen zamanlarda nasıl ve neden editörlük yapabilir? Türkiye eğitim sistemi şartlarında yapıyor işte.

Çok uzatmadan asıl konumuza geliyorum. Yazılımcıların dokümantasyon kültürünü nasıl kullanıyorum? Kısaca ve bildiğim kadarıyla dokümantasyon, yaptığın işi nasıl ve neden yaptığın, hangi teknolojileri ne için kullandığını anlattığın, yazdığın kodları başkasının anlayabilmesi için gerekli sadelikte kayıt altına alma sanatı. İşi bıraktığında ve olağanüstü durumlarda yeni gelen senden kalan işi aynen devam ettirsin veya neyi neden yaptığını anlasın diye. Yanlış biliyorsam yazılımcı arkadaşlar düzeltirse memnun olurum. Meğer bu yöntemi ben de kullanıyormuşum. Yeni fark ettim.

Üzerine çalıştığım içerik işlerini Google Drive üzerinde hazırlıyor ve orada tutuyorum. Yazdığım her metni -ne olursa olsun, ister kabul edilsin ister edilmesin- hiçbir şekilde silmiyorum. Yeri gelir kullanırım ümidiyle Drive üzerinde anlamlı klasörler halinde depoluyorum. Ve evet, yeri geliyor kullanıyorum. Cihaz bağımlılığı olmadan her yerden ulaşabildiğim, başkalarını çalışmaya dahil edebildiğim ve gayet kullanışlı olduğu için Drive bana yetiyor. Daha fazlasına asla ihtiyacım yok. Üzerinde çalıştığım projeleri bitirdiğimde süreci anlatan bir de rapor yazıyorum. Nerelerde sıkıntı yaşadım, hangi bilgiyi nereden aldım, bu ifadeyi neden kullandım gibi sorulara cevap olabilecek hemen her şeyi not ediyorum. Çünkü ilerleyen süreçlerde bu bilgilerin benim için bir yol haritası olacağını biliyorum. Belki aynı çalışmayı güncellemem gerekecek, belki de benzer bir çalışmaya başlayacağım.

Geçenlerde geçmiş bir projenin dosyalarını incelerken farkında olmadan projeyi -Drive dosyalarında olsa da- dokümante ettiğimi gördüm. Sonrasında bunun için bir program veya uygulama var mı diye araştırmaya başladım. Denk gelecek ya, birkaç gün sonra yazılımcı bir arkadaşımın evine misafir oldum. İşlerden konuştuğumuz sırada böyle bir ihtiyacımın olduğunu söyleyince kendi şirketlerinde kullandıkları programdan bahsetti. Uzaktan iş yerine bağlanıp kullandıkları programı anlattı. Dedim tamam, aradığım şey bu. Programın adı Confluence. Meğer Trello ile aynı şirketin ürünüymüş.


O günden bu yana üzerinde çalıştığım projelerin Drive’daki notlarını, süreç raporlarını buraya taşıyorum. Bundaki amacım olağanüstü bir durumda veya yeni gelen bir arkadaşa işleri nasıl yürüttüğümü, neyi, neden yaptığımı olabildiğince sade bir şekilde anlatan yazılı bir doküman bırakmak.

Programın şimdilik deneme sürümündeyim ve ilerleyen zaman içinde ücretli versiyona geçip ofis arkadaşlarımı da bu sürece dahil etmeyi planlıyorum. Trello’yu da ben musallat etmiştim başlarına :) Şu an alışma dönemindeyim. En hoşuma giden tarafı da mobil uygulamalarının olması. Tuttuğum çalışma raporlarına, eski projelere, kullanabileceğim bilgi notlarına istediğim yerden ulaşmak büyük kolaylık. Bulut sistemini seviyorum o yüzden. Bu konuda varsa sizin fikirlerinizi, kullanım ipuçlarını ve genel olarak dokümantasyon kültürü ile söylemek istediklerinizi benimle paylaşabilirsiniz.

Yorumlar