Leistung
Bessere Doku
Ich überarbeite deine Quickstarts, Referenzen und Beispiele, damit Entwickler*innen schneller zu einem funktionierenden Ergebnis kommen.
Ich arbeite in deinem Doku-Stack und im Ton deines Teams. Am Ende des Projekts hat dein Team eine Doku, die es ohne mich aktuell halten kann.
- Preis
- Ab 170 € zzgl. Steuern*Für eine einzelne kurze Seite, etwa 2 bis 3 Stunden zu 85 € pro Stunde. Größere Projekte schätze ich nach Umfang und halte sie im Angebot fest.
- Format
- Remote, auf Deutsch oder Englisch
- Du bekommst
- Überarbeitete Doku, direkt in deinem Repository, und eine Übergabe
- Stack
Hinweis zu Steuern
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?
Passt gut, wenn dir davon etwas bekannt vorkommt
- Dein Quickstart hat mehr Schritte, als irgendwer durchgehen möchte.
- Die Referenz ist vollständig, aber man findet darin nicht, was man braucht.
- Die Beispiele sind Fragmente, die allein nicht laufen.
- Ein Audit hat gezeigt, was zu tun ist, und jetzt muss es jemand umsetzen.
Woran ich arbeite
Die Teile, die Entwickler*innen zuerst lesen
Wir wählen die Teile aus, die für deine Entwickler*innen am wichtigsten sind, und legen sie vorab fest.
Quickstarts
Der kürzeste ehrliche Weg von null zum ersten funktionierenden Ergebnis.
Tutorials und Guides
Schritt-für-Schritt-Anleitungen für die Aufgaben, die deine Entwickler*innen wirklich haben.
Struktur der Referenz
Klare Überschriften, einheitliche Seiten und Typen, auf die man sich verlassen kann.
Beispiele und Samples
Vollständiger, lauffähiger Code, den man kopieren und weiterbauen kann.
Navigation
Eine Informationsarchitektur, die dazu passt, wie Entwickler*innen suchen.
Doku-Tooling
Ein Setup, mit dem Codebeispiele getestet werden und die Doku leicht zu pflegen bleibt.
So sieht das aus
Dieselben Schritte, nur klarer
Ein beispielhafter Quickstart, vorher und nachher.
## Erste Schritte
1. Account anlegen und E-Mail bestätigen.
2. Organisation und Projekt anlegen.
3. API-Key unter Einstellungen > Sicherheit erzeugen.
4. Beispiel-Repository klonen.
5. .env.example nach .env kopieren und sechs Werte ausfüllen.
6. Abhängigkeiten installieren und Build ausführen.
7. Dev-Server starten und Dashboard öffnen.## Den ersten Request senden
Dauer: etwa 5 Minuten. Du brauchst Node 20+
und einen Account (Anmeldung auf example.com).
1. Test-Key holen: Einstellungen > API-Keys.
Test-Keys greifen nicht auf Produktivdaten zu.
2. Beispiel-App anlegen:
npm create example-app@latest
cd example-app
3. Key in .env eintragen (ein Wert):
EXAMPLE_API_KEY=sk_test_...
4. Request senden:
npm run hello
Erwartete Ausgabe: { "status": "ok" }
Etwas anderes? Siehe Fehlerbehebung.
Weiter: deine erste Integration bauen (10 Min.).Ablauf
Vier Schritte, ein klares Ende
- Schritt 1
Wege auswählen
Wir wählen die wichtigsten Wege und Seiten für Entwickler*innen aus und legen den Umfang fest.
- Schritt 2
Entwurf
Ich schreibe und strukturiere direkt in deinem Repository, mit lauffähigen Beispielen.
- Schritt 3
Review
Dein Team prüft die Entwürfe auf fachliche Richtigkeit, und ich arbeite das Feedback ein.
- Schritt 4
Veröffentlichung und Übergabe
Die neue Doku geht live, und dein Team weiß, wie es sie aktuell hält.
Was nicht enthalten ist
Klarheit über den Umfang gehört dazu.
- Änderungen am Produkt selbst. Ich zeige sie auf, und dein Team setzt sie um.
- Laufende Pflege der Doku nach der Übergabe
- Seiten außerhalb des vereinbarten Umfangs
Häufige Fragen
Sollten wir mit einem Audit anfangen?
Nicht unbedingt. Wenn du schon weißt, wo Entwickler*innen hängen bleiben, können wir direkt hier starten. Wenn nicht, macht ein DevEx-Audit das Doku-Projekt fokussierter.
Arbeitest du in unserem Doku-Tooling?
Ja, ich arbeite mit dem, was du schon nutzt. Gut vertraut bin ich mit Docusaurus, VitePress, Astro Starlight, MkDocs (vor allem mit Material for MkDocs) und TypeDoc / JSDoc.
Funktioniert die Doku auch für KI-Coding-Assistenten?
Ich schreibe zuerst für Menschen. Klare Struktur, echte Überschriften, vollständige Beispiele und explizite Typen sind genau das, womit Sprachmodelle gut zurechtkommen, also profitieren sie sowieso.
Mit welcher Seite tun sich Entwickler*innen am schwersten?
Schick mir einen Link, und wir sprechen darüber, was ein Doku-Projekt verändern könnte.
Lieber per E-Mail? Schreib mir direkt