Framework dan library
- Onboarding harus bisa dilakukan secepat mungkin
- Mudah di-upgrade
- Pesan error yang membantu
- Default dan konvensi yang kuat
- Memungkinkan keluar dari pengaturan default
- Mengurangi risiko melalui dependensi
Dokumentasi
- Menjelaskan dengan kode (menyediakan contoh)
- Membantu menyelesaikan masalah (menjawab pertanyaan)
- Menghasilkan dokumentasi secara otomatis (menjaga dokumentasi API dan sebagainya tetap terbaru)
- Juga merangkum cara mengatasi error
- Dioptimalkan untuk skimming (membaca sekilas)
- Harus akurat (hindari jargon dan ungkapan idiomatis)
- Mengekspos hal-hal yang kompleks secara bertahap
API
- Jangan merusak workflow API (versioning): seperti Stripe
- Memungkinkan API diuji dengan cepat: Square sangat baik dalam hal ini
1 komentar
"Mengoptimalkan untuk skimming (membaca sekilas)" sangat relate sekali