Ich schreibe eine klare Readme, Setup-Anleitung oder API-Dokumentation für dein Projekt
Flutter- und Full-Stack-Entwickler
Über diesen Service
Guter Code mit schlechter Dokumentation kostet Zeit. Neue Entwickler und Nutzer können nicht starten, und du beantwortest immer wieder dieselben Fragen. Ich schreibe Dokumentationen, an die sich Leute halten können.
Ich habe rund 10 Jahre bezahlte Entwicklungserfahrung mit Flutter, Web-, Backend- und Cloud-Projekten. Ich lese deinen Code und schreibe die Dokumentation, die er braucht.
Was ich schreibe:
- README-Dateien: Wofür das Projekt da ist, Installation, Ausführung
- Setup-Anleitungen für die lokale Entwicklung
- Benutzungsanleitungen für Anwender
- API-Dokumentation: Endpunkte, Parameter, Beispiele und Fehlercodes
Was du bekommst:
- Markdown-Dateien, bereit zum Hinzufügen in dein Repository
- Klar formulierte, kurze Sätze und funktionsfähige Beispiele
- Eine Dokumentationsstruktur für alle deine Dateien
Wie es funktioniert:
- Teile dein Repository und sag mir, wer die Dokumentation liest.
- Ich bestätige den Umfang, bevor ich anfange.
- Du bekommst die Dateien als Pull-Request oder ZIP.
Nicht enthalten: Arbeiten, die Live-Termine erfordern, und akademische Texte.
Dokumenttyp:
Benutzer- & Schulungshandbücher
•
Dokumentation
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.
FAQ
Automatische Übersetzung
Welches Format liefern Sie?
Markdown standardmäßig. Frag mich nach anderen Formaten, bevor du bestellst.
Benötigen Sie Zugriff auf meinen Code?
Ja. Die Dokumentation muss mit dem echten Code übereinstimmen.
Können wir telefonieren?
Nein. Ich arbeite nach klaren schriftlichen Briefings. Ich antworte werktags innerhalb von 24 Stunden.
Kannst du eine API mit einer OpenAPI-Datei dokumentieren?
Ja. Wenn du eine OpenAPI- oder Swagger-Datei hast, schick sie mir. Das macht die Arbeit schneller.
