Ich erstelle technische Dokumentation, Readme und API-Dokumente für dein Projekt
AI-Automatisierung und Full-Stack-Entwickler
Über diesen Service
Dein Projekt funktioniert. Das Problem ist, dass niemand es ohne drei Fragen an dich zu stellen, nutzen kann.
Ich bin Full-Stack-Entwickler, also lese ich deinen Code, bevor ich darüber schreibe. Du musst mir dein Projekt nicht Zeile für Zeile erklären.
WAS DU BEKOMMST
- Ein Readme, das die vier Fragen in der richtigen Reihenfolge beantwortet: Was ist das, wie installiere ich es, wie führe ich es aus, was mache ich, wenn es kaputt geht
- Installationsschritte, die ich tatsächlich befolgt habe, mit echten Voraussetzungen und Versionen, nicht nur Vermutungen
- Jede Umgebungsvariable in einer Tabelle: was sie macht, ob sie erforderlich ist, ein sicheres Beispiel
- API-Referenz mit Methode, Pfad, Authentifizierung, Parameter, einer echten Anfrage und einer echten Antwort
- Jeder Fehlercode, den dein Service zurückgeben kann, und was der Aufrufer dagegen tun sollte
- Ausführbare Beispiele in curl und JavaScript, getestet und nicht nur illustrativ
STACKS, DIE ICH GERN LESEN
JavaScript, TypeScript, React, React Native, Node.js, Express, PostgreSQL, Supabase, n8n Workflows, REST und Webhooks.
Geliefert als Markdown, bereit zum Commit oder als Dokumentationsseite im Premium-Paket. Ich schreibe auf Englisch und Brasilianisch-Portugiesisch und kann beide Versionen desselben Dokuments liefern.
Dokumenttyp:
Dokumentation
•
Technische Spezifikationen
Branche:
Software
Sprache:
Englisch
•
Portugiesisch
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.
FAQ
Automatische Übersetzung
Muss ich dir meinen gesamten Code erklären?
Nein. Gib mir Zugriff auf das Repository oder eine Zip-Datei, und ich lese es. Ich komme mit einer kurzen Fragenliste zurück, nur dort, wo der Code sich nicht selbst erklären kann.
Ist mein Code vertraulich?
Ja. Ich reuse, veröffentliche oder teile keinen Kunden-Code und bin gerne bereit, vor dem Senden eine NDA zu unterschreiben.
Kannst du eine private oder interne API dokumentieren?
Ja. Wenn es eine Sammlung gibt (Postman, Insomnia, OpenAPI), sende sie mir. Wenn nicht, lese ich die Routen.
Kannst du sowohl auf Englisch als auch auf Portugiesisch schreiben?
Ja. Bitte frage nach der zweisprachigen Lieferung, dann bekommst du beide Versionen desselben Dokuments.

