Hatırlarsanız “projenizi iyi yönettiğinizden ne kadar eminsiniz?” başlıklı yazımda yer alan proje yönetimi süreçlerinde, özellikle “kapanış süreçleri” şirketin en önemli varlıklarından birisi olduğundan bahsetmiştim. Kapanış sürecinde yapılan işlemleri hatırlatmak gerekirse şöyle özetleyebiliriz:
- İşin müşteriye devredilmesi
- Projenin başarısının değerlendirilmesi
- Alınan dersler (lessons learned) raporunun hazırlanması
- Kayıtların arşivlenmesi
- Ekibin serbest bırakılması / dağıtılması
- Proje, kapanış duyurusu
Burada özellikle “alınan dersler” raporunun hazırlanması başta olmak üzere farklı amaç ve ihtiyaçlarla, farklı tipte dokümanlar oluşturmak gerekiyor. İşte bu noktada sizlere ileri seviye proje dokümanı oluştururken nelere dikkat etmeniz gerektiğine yönelik bilgiler aktaracağım.
Bir projede hangi belgelerin bulunabileceğini bilmek, evet bir şey olabilir, ancak yüksek kalitede belgeler oluşturmak ise bambaşka bir şey. Yüksek kalitede olan belgeler, projedeki herkesin neyin gerekli olduğu, durumun ne olduğu ve bir sonraki aşamada neler olacağının kesinlikle açık olmasını sağlar. Şimdi gelin doküman yaratırken nelere dikkat edilmesi gerektiğine:
Basitlik
Gereksiz bilgileri hariç tuttuğunuzdan emin olarak, belgelerinizi mümkün olduğunca basit ve yalın oluşturun. Belgeleri açık ve net bir şekilde yazın. Başkalarının anlamadığı kısaltmalar veya terimlerin kullanımını sınırlayın. Bu, belgelerin okunmasının kolay ve hızlı olmasını sağlayacaktır.
Odak
Belgenizi oluştururken “asıl konu” ‘ya odaklanın. Belgeye ekleyeceğiniz içerik hakkında dikkatli düşünün. Konularınızı listeleyin ve bunlara bağlı kalın. Okuyucuyu tamamen karıştırabileceği için de konudan asla çıkmayın.
Yapı
Tüm belgeleriniz iyi tanımlanmış bir “İçindekiler Tablosu” da dahil olmak üzere net bir yapıya sahip olmalıdır. Okunabilirliği geliştirmek, içeriğin daha fazla açıklanması için diyagramlar eklemek, başlıklar gibi belirli alanları öne çıkarmak için kalın, italik ve alt çizgi kullanmak ve ilişkili ögelerden oluşan bir grup veya grup tanımlarken, belgenize tabloların dahil edilmesini isteyebilirsiniz. Ayrıca listeleme (bullets) elemanlarını kullanmayı ihmal etmeyin.
Hikaye
Belgeleri, tıpkı bir hikaye anlatır gibi oluşturun. Bu okunabilirliği artıracak, aynı zamanda okuyucunun belgeyi sıkılmadan ve dikkatlice inceleyebilmesini sağlayacaktır. Bir “giriş” ile başlayın ve okuyucuya belgenin muhakkak ne hakkında olduğunu bildirin. Daha sonra ana içeriği veya gövdeyi ekleyin. Son olarak belgeyi bir özet veya sonuçla kapattığınızdan emin olun.
Akış
Belgenizi, paragraftan paragrafa ve konudan konuya akacak şekilde yazın. Bu, okuyucunun belgede nerede bulunduğunu veya bir sonraki adımın ne olduğunu öğrenmek için durmak zorunda kalmamasını sağlayacaktır.
Bilgi Miktarı
Okuyucuyu doğru miktarda bilgi verin. Basit ve kısa tutun, ancak bunun da bilgilendirici ve yararlı olduğundan emin olun. Asla her şeyi açıklamaya çalışmayın çünkü bu durum belgenin okunması zorlaştırır ve okuyucunun sıkılmasına neden olabilir.
İlham
Yazdığınız konu hakkında tutkulu olun ve okuyucuya sağladığınız bilgilerle ilham verdiğinizden emin olun. Belge boyunca olumlu ve ilham verici olun. Okuyucuyu heyecanlandırın ve dokümanın okunmasını eğlenceli hale getirin.
Ayrıca şunları da akıldan çıkarmamakta fayda var:
- Mümkünse resimlerle belgeleyin
- Örnek verin
- Varsayım yapmayın
- Sorunları tahmin edin
- Belgelerinizi test edin
- İşinizi insancıllaştırın
- Yeni teknolojileri keşfedin
- Mümkünse dokümantasyonu kendiniz yapın
- Son Kullanıcı Dokümantasyonunu, Dahili / Sistem Dokümantasyonu ile geliştirilmesini koordine edin
- Departman veya kurumsal dokümantasyon yönergelerini takip edin
Referans: Sherie Smith, Entrepreneur and Internet Visionary at Project Templates
