Dökümantasyon, iş analizinin en önemli aşamalarından birisidir. İhtiyaç analizini takip eder ve üretimin başlamasını sağlar. İş analistinin, müşteri ve ekibi ile arasındaki anahtar rolünün en çok hissedildiği aşama dökümantasyondur. Dökümantasyon aşamasında ihtiyaç analizi sürecinde atlanmış, gözden kaçmış olabilecek adımlar fark edilebilebilecek ve eksikler giderilebilecekken; baştan savma ve özensiz hazırlanan bir dökümantasyon işi yavaşlatacağı gibi çıkacak ürünü de olumsuz etkileyebilir. Dikkatli ve özenli bir şekilde yapılmış bir ihtiyaç analizi sonrasında hazırlanan dökümantasyon, geliştirme ve test aşamalarında yol gösterici rol oynar.
İş analistleri olarak hem müşteri hem de işi yapacak takım ile beraber çalıştığımız için, yapacağımız dökümantasyonlar her iki kesim tarafından da anlaşılabilecek dilde olmalıdır. Her iş analistinin iyi bir dökümantasyon için dikkat etmesi gereken bazı anahtar noktalar vardır. Teknik ekip için bir noktayı vurgularken, teknik bilgisi olmayan müştetinin de o cümleyi anlayabilmesini sağlamak gerekir. İşini iyi yapan bir iş analisti işte bu aşamada belli olur.
İşte iyi bir dökümantasyon için dikkat etmemiz gereken 15 önemli nokta:
- Kullandığınız dile ve o dilin dil bilgisi kurallarına hakim olun.
- Her zaman kısa ve anlaşılır cümleler kurmaya özen gösterin.
- Dökümantasyonda bir jargon kullanıyorsanız, ek açıklamalarla o jargona hakim olmayan kişilerin de okuduğunu anlayabilmesini sağlayın.
- Cümlelerinizi 10 kelimeden uzun kurmamaya çalışın.
- Dökümantasyonunuzda font uyumluluğuna dikkat edin.
- Yazdığınız cümlelerin okunabilirliğini kontrol edin.
- Anlaşılabilirliği arttırmak için görseller kullanın.
- Dökümanınızın adını versiyonlayarak saklayın.
- Tüm dökümanlarda sayfa başlığı (header) ve sayfa alt metni (footer) kullanmaya çalışın.
- Excel’de hazırladığınız dökümantasyonlarda üst satırın (genellikle başlıkları içeren satır olduğu için) font ve görünümüne dikkat edin.
- Excel dökümanlarında, dökümanın görselliği ve okunabilirliği için her zaman wrap text (aynı hücre içinde alt satıra kaydırma) testi yapın.
- Excel üzerinde yaptığınız çalışmaları teslim etmeden önce yazdırma önizlemesi yapın ki dökümanı alan bir kişi çıktı alma ihtiyacı duyarsa düzgün bir çıktı alabilsin.
- PowerPoint üzerinde çalışıyorsanız, siyah veya koyu bir renk arka planda çalışmaya özen gösterin. Bu sayede hazırladığınız döküman beyaz bir alana yansıtıldığında yansıma yapmadan, düzgün görünecektir.
- PowerPoint dosyanızda tek bir konuya odaklanın. Sayfalar arasında bağ kurulabilmesi önemlidir. Daldan dala, konudan konuya atlayan sunumlar dinleyen ve okuyanların dikkatinin dağılmasına neden olacaktır.
- PowerPoint dosyalarında, boyutu iyi ayarlanmış ve dikkatli seçilmiş bir görsel ile kısa, açıklayıcı bir metin en etkili sunum materyeli olacaktır. Dinleyiciyi sunum üzerinde görsele veya metne boğmaktansa, dengeyi sağlamak herkesin konuya odaklanmasını sağlar.
