Documentation'ı Kod'dan Sonraya Bırakmak

Özellik merge oldu. README hâlâ eski uçları anlatıyordu. İlk soru Slack'te, ikinci soru aynı thread'de, üçüncü soru yeni gelen birinden. Üçü de PR açıklamasında duruyordu. PR açıklaması, merge sonrası aranmıyor.

Ne yazılır

Nasıl çalıştırılır, nerede kırılır, bilinçli olarak ne yok. Satır satır API ezberi değil — o, imzadan çıkar. Çıkmayan şey: 'neden bu sınır', 'hangi ortam değişkeni yoksa sessiz kalır', 'hangi iş bilinçli yok'.

Yorum ile dokümanı karıştırmıyorum. Yorum, bu fonksiyonun yerel tuzağı. Doküman, bu işi ilk kez koşturacak kişi. İkisini aynı 'sonra yazarız' kutusuna koymak, ikisini de yazmamak.

PR kapısı

davranış değiştiyse doküman da değişir. Kontrol listesinde bir kutu. Kutuyu 'n/a' yapmak serbest; gerekçesi 'değişen dış davranış yok'. Gerekçe 'vakit yok' ise kutu kırmızı. 800 satırlık PR yazısındaki gibi: sonra, gelmiyor.

Kısa tutuyorum. Bir sayfa, bir komut bloğu, bir 'bilinçli yok' listesi. Wiki bahçesi eklemiyorum. Bahçe, sonra'nın evlendiği yer; kimse sulaamayınca kurumuş link kalıyor.