Framework'ler ve kütüphaneler
- Mümkün olduğunca hızlı onboarding sağlayabilme
- Kolay yükseltme
- Faydalı hata mesajları
- Güçlü varsayılanlar ve konvansiyonlar
- Varsayılan ayarlardan çıkışı mümkün kılmak
- Bağımlılıklar yoluyla riski azaltmak
Dokümantasyon
- Kodla anlatmak (örnekler sunmak)
- Sorun çözmek (sorulara yanıt vermek)
- Dokümantasyonu otomatik üretmek (API dokümanları gibi şeyleri güncel tutmak)
- Hatalar için çözüm yollarını da derlemek
- Skimming'e (hızlıca göz gezdirme) uygun hale getirmek
- Doğru olmak (jargon ve deyimlerden kaçınmak)
- Karmaşık şeyleri aşamalı olarak görünür kılmak
API'ler
- API iş akışını bozmamak (Versioning): Stripe gibi
- API'nin hızlıca test edilebilmesini sağlamak: Square bunu iyi yapıyor
1 yorum
"Skimming(kabaca göz atma) için optimize etmek" bana da inanılmaz derecede katılıyor