Ich werde technische Dokumentation für deine bestehende Anwendung erstellen
Cloud-Anwendungsentwickler, KI-Automat, Fotograf
Über diesen Service
Klare, entwicklerfreundliche Dokumentation, die tatsächlich gelesen wird.
Egal, ob du ein poliertes README, eine umfassende API-Referenz oder eine vollständige Dokumentationssuite für deine Anwendung brauchst, ich kümmere mich um das Schreiben, damit du dich auf den Aufbau konzentrieren kannst.
Was ich in jedes Projekt einbringe:
- Erfahrung in der Dokumentation von REST-APIs, SDKs, CLIs und Webanwendungen
- Vertrautheit mit Markdown, OpenAPI/Swagger und Github (für Vorlagen)
- Sauberes, strukturiertes Schreiben, angepasst an dein Publikum: Entwickler, Endnutzer oder beides
Alle Deliverables sind:
- Gut organisiert und leicht zu navigieren
- In einfachem, präzisem technischem Englisch geschrieben
- Formatiert, um deinem Style Guide oder einer Standardkonvention zu entsprechen
Bevor wir starten, werde ich deine Codebasis, API-Spezifikation oder vorhandene Dokumente überprüfen, um sicherzustellen, dass alles genau und vollständig ist.
Hast du ein Projekt im Kopf? Schick mir eine Nachricht und lass uns sprechen.
Dokumenttyp:
Dokumentation
•
Standard Operating Procedures (SOPs)
Branche:
Software
Sprache:
Englisch
•
Französisch
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
Was benötigen Sie von mir, um zu beginnen?
Mindestens Zugriff auf deine Codebasis, API-Spezifikation (z. B. OpenAPI/Swagger) oder vorhandene Dokumente. Je mehr Kontext du im Voraus teilst, desto genauer wird das Ergebnis.
Kannst du eine API ohne eine Spezifikationsdatei dokumentieren?
Ja, ich kann direkt mit deiner Codebasis, Postman-Sammlungen oder einer laufenden API arbeiten. Beispielanfragen und -antworten zu haben, hilft enorm.
In welchem Format wird die Dokumentation geliefert?
Standardmäßig liefere ich Markdown (.md)-Dateien, die direkt in dein Repository oder deine Dokumentationsplattform eingebunden werden können. Ich kann auch HTML, PDF oder jedes andere von dir angegebene Format liefern.
Deckt du interne oder private Dokumentation ab?
Ja, ich habe interne Entwicklerleitfäden, Runbooks und Onboarding-Dokumente geschrieben, zusätzlich zu öffentlich zugänglichen API-Referenzen und Benutzerhandbüchern. Alles wird standardmäßig vertraulich behandelt.
