Ich werde deine Entwicklervokumentation auditieren und beheben, was dir Nutzer kostet
Technische*r Redakteur für KI und Entwickler-Tools, API-Dokumentation, Benutzerhandbücher, SOPs
Über diesen Service
Deine Dokumentation könnte der Grund sein, warum Entwickler vor der Integration abspringen. Ich prüfe sie so, wie es ein neuer Entwickler tun würde: Ich folge deinem Quickstart, rufe deine Endpunkte auf und merke mir jede Stelle, an der ich hängen bleibe.
Was du bekommst:
- Eine priorisierte Auflistung von fehlerhaften Schritten, fehlenden Informationen, veralteten Beispielen und verwirrender Struktur
- Schnelle Behebungen, die du noch am selben Tag anwenden kannst
- Eine empfohlene Struktur für deine Docs für die Zukunft
- Im Premium-Paket schreibe ich die Seiten um, die es am stärksten benötigen
Warum ich: Ich betreue die Entwicklervokumentation bei Gaffa, einer Web-Scraping-API, wo ich jeden Endpunkt vor der Dokumentation teste und die Stellen finde, an denen Produkt und Docs auseinanderklaffen. Zuvor arbeitete ich als KI-Ingenieur, also lese ich Code und nicht nur Docs.
Tools, mit denen ich arbeite: GitBook, Mintlify, Docusaurus, MkDocs, Markdown, OpenAPI/Swagger, Postman und GitHub.
Schick mir einen Link zu deinen Docs und ich sage dir, worauf ich zuerst schauen würde.
Dokumenttyp:
Dokumentation
•
Technische Spezifikationen
Branche:
Software
Sprache:
Englisch
Bevorzugte Lieferart
Bitte informiere den Freelancer über alle Präferenzen oder Bedenken in Bezug auf den Einsatz von KI-Tools bei der Ausführung und/oder Lieferung deines Auftrags.
