HERHANGİ BİR dokümantasyon NO dokümantasyonundan daha iyi buldum. Uygun miktar genellikle bunu yapmamız gereken süreye veya telefon görüşmelerinden ve e-postalardan ne kadar nefret ettiğimize göre belirlenir.
Mevcut ekip üyelerinizin anıları hakkında gerçekçi olmayan beklentileri olduğu ya da yazma becerilerinden utandıkları ve pratik yapmak istemedikleri anlaşılıyor.
Belgeyi angarya olarak bulamadığım için burada bir azınlıktayım (lisansüstü okulda yazılım mühendisliğine giren İngiliz bir anadal). Değerli bir profesyonel araç. Yazmayı bazı iş arkadaşlarım kadar zor bulamayabilirim, ama bunun sebebi daha çok pratik yapmam. Bir projenin belgeleri olmadığı sürece bittiğini düşünmüyorum ve genellikle tamamen bencilce nedenlerle yazıyorum: bu yüzden telefon görüşmeleri ve e-postalar almak yerine insanlara bir şeyler okuyabilirim, ya da en son ne hakkında konuştuğumuzu hatırlayabilirim veya gecenin ortasında desteklemem gerekirse nasıl bir şey yaptığımı anlatabilirim.
Belgelere yaklaşmanın en iyi yolu, tıpkı test kodu yazmak gibi, SİZİN GİBİ gibi yazmaktır. Önceden yazılmış birkaç şablonun (başlıklar, kod dizileri vb.) Dokümantasyonu nasıl daha kolay ve hızlı hale getirebileceği şaşırtıcı. Bu şekilde, değişikliği gerçekleştiği anda yakalayabilirsiniz ve zamanla örtmek için daha az zemine sahip olursunuz. Bu şekilde daha verimli olursunuz, çünkü belgelere ihtiyacınız olduğu gibi başvurabilir ve bu şekilde değiştirebilirsiniz. Örneğin, bir wiki'de bunu yapmak güncelleştirmeleri kolaylaştırır ve en son ve en büyüğü her zaman aynı yerde çevrimiçi olduğunda belge sürümü sorunlarından kaçınabilirsiniz ve yalnızca okuması gereken kişilere bağlantılar gönderebilirsiniz.
Belgelemek için biraz zaman harcarsanız, özellikle de yeni bir kişi takıma katıldığında TÜM daha hızlı çalışacaksınız, çünkü her şeyi anlamak için zaman harcamak zorunda kalmayacaklar. Bir şeyler bulmak işimizin eğlenceli bir parçası, ancak üretimi düzeltmek için acele etmeniz gerektiğinde eğlenceli değil. Hepimiz birkaç not daha yazsaydık hepimiz çok zaman kazanırdık.
Ekibinizin test veya test kodu yazmayla aynı sorunları var mı? Değilse, bu daha kolay bir satış olacaktır.
Belgeleriniz birçok açıdan faydalıdır:
1) Proje üzerinde çalışırken şu anda size ve iş arkadaşlarınıza.
2) müşterilerinize. Kullanıcılara gösterebileceğiniz belgelere (diyagramlar dahil) sahip olmak, özellikle karmaşık sistemleri tartışıyorsanız, toplantılardaki tartışmaları kolaylaştırır. Belgeler eksik olsa bile, başlangıç noktasıdır.
3) Çalışmanızı devralacak insanlara (üç yıl içinde bile siz olabilirsiniz). Genç meslektaşlarımın çoğu, sonsuza dek bir şeyler hatırlayacaklarını düşünüyor. Bunu yazmazsam bu haftadan sonra hatırlamayacağımı biliyorum. Belgelere sahip olmak, bir şeyi nasıl yapılandırdığınızı hatırlamak ve her şeyi tekrar anlamak zorunda kalmak için yarım gün harcamaktan kurtarır.
4) Durum siyasi veya tartışmalı olursa, size ve başkalarına. Toplantılarda not alan biri olarak, kendimi uyanık tutmak ve can sıkıntısıyla mücadele etmek için, genellikle kararın yazılı versiyonuna sahip olan tek kişi oldum. Yazan kişi anlaşmazlığı kazanır. Bir dahaki sefere birisi "Geçen kış konferans salonu 4'te buluştuğumuzu, X'in üzerine gittiğimizde? Fred oradaydı ve Muhasebe'den gelen adam kim?"