Yazılım Geliştirmede Dökümantasyon


Öncelikle bu yazıya başlamadan beni bu konuda bilinçlendiren iki insana teşekkür etmek istiyorum.İlker manap ve Nikos Efthias hocalarıma teşekkür etmek istiyorum.

 

DÖKÜMANTASYON NEDİR ?

Dokümantasyon, düşünce ürünü olan bütün bilgileri toplama, sınıflama ve kolayca yararlanmaya sunulacak biçimde saklama işlemi; bilimsel haberleşmenin en büyük hız ve doğrulukla gerçekleşebilmesi için yapılan işlemlerin tümü.

NEDEN  DÖKÜMANTASYON HAZIRLANIR ?

Kısacası eğer bir geliştirme ekibinde veya açık kaynak bir uygulama geliştiriyor isek ürettiğimiz  yazılımı başka kullanıcı ve geliştiriciler için daha anlaşılabilir hale getiriyor.Bir senaryo oluşturalım,siz birkaç kişi ile birlikte bir yazılım geliştiriyorsunuz ancak yapılan işlemleri daha anlaşılır hale getirmek için dökümantasyon hazırlamak projeyi daha anlaşılabilir hale getirir.
Örnek dökümantasyon  olarak  https://golang.org/doc/, https://docs.couchdb.org/en/stable/ websitelerini inceleyebilirsiniz.