Ich erstelle Entwicklerdokumentation und API-Dokumente für dein SaaS
Technischer Redakteur, API-Dokumentationsingenieur für KI- und SaaS-Produkte
Über diesen Service
Dein Produkt verdient Dokumentation, die wirklich funktioniert, nicht nur Dokumentation, die existiert.
Ich bin technischer Redakteur und DevRel-Ingenieur, der API-Referenzen, Entwicklerleitfäden und Produktdokumentationen für SaaS- und Dev-Tool-Unternehmen schreibt. Ich beschreibe deine API nicht nur anhand eines Spezifikationsblatts, sondern teste sie praktisch, entdecke Lücken und Fehler, die andere Autoren übersehen, und schreibe Dokumente, denen Entwickler tatsächlich folgen können, ohne stecken zu bleiben.
Was ich mitbringe:
- Live-API-Tests, bevor ich eine Zeile schreibe, damit die Dokumentation genau das widerspiegelt, was dein Produkt tatsächlich macht
- Klare Struktur: Überschriften, Beispiele und FAQs, organisiert so, wie Entwickler scannen, nicht so, wie Marketer schreiben
- Erfahrung mit GitBook, Markdown und REST-API-Dokumentation
- Hintergrund in AI/ML-Engineering, damit ich technische Konzepte präzise erkläre, nicht nur plausibel
Ich habe vollständige API-Flächen für Browser-Automatisierung und SaaS-Produkte dokumentiert, Style-Guides für Konsistenz in großen Dokumentensätzen erstellt und Onboarding-Inhalte geschrieben, die die Entwicklerakzeptanz messbar verbessert haben.
Wenn du Dokumentation möchtest, die Support-Tickets reduziert statt generiert, lass uns sprechen. Schick mir eine Nachricht mit deinen Produkt- oder API-Details, und ich sage dir genau, wie.
Dokumenttyp:
Benutzer- & Schulungshandbücher
•
Dokumentation
Sprache:
Englisch
•
Andere
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.
Mein Portfolio
FAQ
Automatische Übersetzung
Brauche ich Zugriff auf mein Produkt oder meine API, um die Dokumentation zu schreiben?
Ja, idealerweise. Ich teste APIs und Produktabläufe praktisch, bevor ich schreibe, weil ich so Fehler entdecke, die andere Autoren übersehen. Wenn kein Zugriff möglich ist, kann ich auch anhand deiner Spezifikationen oder vorhandener Dokumente arbeiten.
Mit welchen Tools und Formaten arbeitest du?
Ich schreibe in Markdown und arbeite direkt in GitBook, Notion, Confluence oder Word/Google Docs, je nachdem, was dein Team nutzt. Ich kann auch einen bestehenden Style-Guide anpassen oder beim Erstellen helfen, falls nötig.
Kannst du Dokumentation von Grund auf neu schreiben oder nur bestehende Dokumente überarbeiten?
Beides. Ich schreibe neue Dokumentation von einer leeren Seite und überprüfe sowie überarbeite auch bestehende Dokumente, die veraltet, unklar oder inkonsistent sind.
Wie funktionieren Revisionen?
Jedes Paket beinhaltet eine Reihe von Überarbeitungen, die Änderungen an Struktur, Klarheit und Genauigkeit abdecken. Wünsche außerhalb des ursprünglichen Umfangs, wie neue Seiten oder größere Themenänderungen, gelten als neue Bestellung oder Extra.
Was passiert, wenn sich mein Produkt nach der Lieferung der Dokumentation ändert?
Ich freue mich, laufende Updates als separate Bestellung durchzuführen. Wenn du regelmäßige Änderungen erwartest, schick mir eine Nachricht, und wir richten eine einfache monatliche Retainer-Vereinbarung ein.
Unterzeichnen Sie NDAs?
Ja. Ich arbeite regelmäßig mit Early-Stage-Produkten und Pre-Launch-APIs und bin bereit, vor der Überprüfung vertraulicher Materialien eine NDA zu unterschreiben.
