dokümantasyon

• “documentation is like sex: when it is good, it is very, very good;
  and when it is bad, it is better than nothing.”—dick brandon
  
  yani diyor ki: "dokumantasyon seks gibidir: iyi olduğunda, çok, çok iyidir;
  kötü olduğunda ise, hiç yoktan iyidir."
• "yaptığını yaz, yazdığını yap" felsefesinin, "yaptığını yaz" kısmı.
• "documentation wakes the hunter-gatherer in the system administrator. you might end up collecting stuff that you write into your documentation but never use."
  
  "the number one reason for a dying it-documentation…is when either you or your coworkers lose their trust in the accuracy of the documentation. and this happens either when they find old/incomplete information or when they don’t have any trust in the documentation in the first place."
  
  kaynak
• ileride işe yarayacağı bilinmesine rağmen hazırlaması işkence gibi gelir insana.
• yazılım dünyasında dokümantasyon, yazılan kodun kendisinden daha önemli bile olabilir. yarın bir gün "şu fonksiyon hangi parametreleri, niye alıyordu, nereye pas ediyordu" diye düşününce, koda bakmadan bu soruya yanıt bulabilmek güzel olmaz mı benjamin? tabi, iyi kod kendi kendisinin dokümantasyonunu oluşturur, elbette.
  - always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live.
• çok büyük projelerde çok önemli olan şey. adam gibi yapıldığında inanılmaz zaman kazandırır, zaman kayıplarını önler.
• uzun süreli projeler için oldukça gerekli bir işlemdir. öyle ki; kendi yaptığınız işi bile unuttuğunuz noktaya geldiğinizde açıp okunacak bir dökümantasyon hayat kurtaran bir unsurdur.
• ozellikle genc denetcilerin korkulu ruyasidir. field biter ama dokumantasyon bitmez.
• yaptığım işin en sevmediğim kısmı. ne yazarsan yaz müşteri illa "dünyada yaşam nasıl ortaya çıktı" sorusunun cevabını da ister dokümanın içerisinde.
• proje gelişim sürecinde değil de proje bitiminde yapılırsa tüm proje süresi kadar zaman alabilir.