Leistung
Ich gehe Doku, APIs, SDKs und Onboarding so durch, wie es neue Entwickler*innen tun, und du bekommst eine priorisierte Liste mit Verbesserungen.
Du erfährst, wo Entwickler*innen hängen bleiben, bevor sie aufgeben, und was du zuerst ändern solltest. Das Audit hat einen festen Umfang, damit du weißt, was du bekommst und wann.
Für Kund*innen in Deutschland kommen 19 % Mehrwertsteuer dazu. Für Kund*innen im Ausland stelle ich den Nettobetrag in Rechnung, und du führst die Steuer in deinem Land selbst ab, etwa per Reverse-Charge-Verfahren. Bitte stell sicher, dass dein Unternehmen das kann.
Passt das zu dir?
Was ich mir ansehe
Den genauen Umfang legen wir vorab fest. Diese Bereiche deckt ein Audit normalerweise ab.
Jeder Schritt vom ersten Besuch deiner Website bis zum ersten funktionierenden Ergebnis.
Ob Menschen die Antwort finden, und ob die Antwort vollständig ist.
Benennung, Konsistenz, Typen und wie vorhersehbar sich deine API verhält.
Installation, Konfiguration und Nutzung deiner SDKs, CLIs und Templates.
Ob eine Fehlermeldung sagt, was schiefgelaufen ist und wie man es behebt.
Ob sie vollständig und lauffähig sind und zu dem passen, was Menschen bauen.
Was du bekommst
Jeder Befund beschreibt, was passiert, warum es wichtig ist und was du ändern solltest, sortiert nach Priorität. Hier ein Beispiel.
Fast alle neuen Entwickler*innen stoßen beim ersten Request darauf. Die Fehlermeldung verrät nicht, was fehlt, also müssen sie die Doku verlassen und selbst suchen. Empfehlung: In der Fehlermeldung den fehlenden Key benennen und darauf verlinken, wo man ihn bekommt.
HTTP 400 Bad Request
{ "error": "invalid_request" }HTTP 400 Bad Request
{
"error": "missing_api_key",
"message": "Add your API key in the Authorization header.",
"docs": "https://docs.example.com/auth"
}Ablauf
Wir legen Umfang und Zielgruppe fest und bestimmen die wichtigsten Wege, die Entwickler*innen gehen.
Ich gehe die ersten Schritte durch, als wäre ich neu bei deinem Produkt, und notiere jede Stelle, an der ich stolpere.
Ich schaue mir Doku, API und SDKs hinter jedem Stolperstein an und erarbeite, was sich ändern sollte.
Du bekommst die priorisierten Befunde, und wir gehen sie gemeinsam mit deinem Team durch.
Klarheit über den Umfang gehört dazu.
TypeScript und JavaScript, Frontend und Backend, inklusive Node.js und Deno. Außerdem Typst. PHP und einige andere Sprachen auf Anfrage.
Einen Testaccount oder Sandbox-Zugang, Zugriff auf deine Doku und Repositories (falls relevant auch auf unveröffentlichte Entwürfe), eine kurze Beschreibung, wer deine Entwickler*innen sind, und eine Ansprechperson im Team.
Das Audit konzentriert sich auf Menschen. Semantische Doku und intuitive APIs funktionieren auch für Sprachmodelle, deshalb folgen bessere Ergebnisse mit KI-Tools aus guter Developer Experience.
Erzähl mir in einem kurzen Gespräch von deinem Produkt. Wenn ein Audit nicht passt, sage ich es dir.
Lieber per E-Mail? Schreib mir direkt