Frameworks und Bibliotheken
- Möglichst schnelles Onboarding ermöglichen
- Einfache Upgrades
- Hilfreiche Fehlermeldungen
- Starke Standardwerte und Konventionen
- Es ermöglichen, aus den Voreinstellungen auszubrechen
- Risiko durch Abhängigkeiten reduzieren
Dokumentation
- Mit Code erklären (Beispiele bereitstellen)
- Probleme lösen (Antworten auf Fragen geben)
- Dokumentation automatisch generieren (API-Dokumentation usw. aktuell halten)
- Auch Lösungswege für Fehler dokumentieren
- Für Skimming (schnelles Überfliegen) optimieren
- Präzise sein (Fachjargon und Redewendungen vermeiden)
- Komplexe Dinge schrittweise offenlegen
APIs
- API-Workflows nicht unterbrechen (Versionierung): wie bei Stripe
- APIs schnell testbar machen: Square macht das gut
1 Kommentare
„Für
Skimming(oberflächliches Lesen) zu optimieren“ spricht mir total aus der Seele.