Frameworks et bibliothèques
- Onboarding aussi rapide que possible
- Mises à niveau faciles
- Messages d’erreur utiles
- Valeurs par défaut et conventions solides
- Permettre de s’échapper des réglages par défaut
- Réduire les risques grâce aux dépendances
Documentation
- Expliquer par le code (fournir des exemples)
- Résoudre les problèmes (répondre aux questions)
- Générer automatiquement la documentation (garder à jour la documentation API, etc.)
- Documenter aussi les solutions aux erreurs
- Optimiser pour la lecture en diagonale
- Être précis (éviter le jargon et les tournures idiomatiques)
- Exposer progressivement les éléments complexes
API
- Ne pas casser les workflows API (versioning) : comme Stripe
- Permettre de tester rapidement l’API : Square le fait bien
1 commentaires
« Optimiser pour la lecture en diagonale » me parle énormément.