Kategorien durchsuchen
Entdecken
Fiverr Pro
Deutsch
$
USD
Ich erstelle API-Dokumentation, OpenAPI Swagger-Spezifikation, Entwicklerleitfäden und SDK-Dokumente
Technische Dokumentation und Datenautomatisierung für Softwareteams
Ich bin Softwareingenieur. Ich schreibe die Dokumente, die Softwareteams brauchen und niemand schreiben möchte: Anforderungsspezifikationen, API-Referenzen, Benutzerhandbücher, Runbooks. Und ich autom...
Über diesen Service
Schreib mir ruhig auf Italienisch.
Die meisten API-Dokumentationen werden von jemandem geschrieben, der den Code nicht lesen kann. Deshalb werden sie nach drei Wochen veraltet, und deine Nutzer öffnen immer noch Tickets, um zu fragen, was die Fehlercodes bedeuten.
Ich bin Softwareentwickler. Schick mir das Repository, die Postman-Sammlung oder die Routen-Datei – ich lese sie selbst und schreibe eine Dokumentation, die genau beschreibt, was der Service tatsächlich macht.
WAS DU BEKOMMST
- Zu jedem Endpoint: Methode, Pfad, Authentifizierung, Parameter, Anfrage und Antwort
- Echte Fehlerantworten, inklusive Ursachen und Lösungsvorschlägen
- Ein funktionierendes Beispiel pro Endpoint, in curl und in einer Sprache deiner Wahl
- Eine gültige OpenAPI 3-Datei, damit die Dokumentation nach Codeänderungen neu generiert werden kann
- Eine veröffentlichte Dokumentationsseite auf Redoc, Swagger UI oder Mintlify (Premium)
REST, GraphQL, Webhooks und SDKs. Ich benötige nie deine Produktionsschlüssel.
Wenn deine API Probleme mit Benennung oder Fehlerbehandlung hat, sage ich dir das, bevor ich schreibe. Eine verwirrende API zu dokumentieren, macht die Verwirrung nur offiziell.
Dokumenttyp:
Dokumentation
•
Technische Spezifikationen
Branche:
Software
Sprache:
Englisch
•
Italienisch
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
Was brauchst du, um meine API zu dokumentieren?
Eines dieser Dinge reicht: ein Repository, eine Postman-Sammlung, ein GraphQL-Schema, eine bestehende OpenAPI-Datei oder ein Sandbox-Schlüssel. Wenn du keines hast, reicht ein Screen-Sharing, bei dem du mir die Calls erklärst, um zu starten.
Veröffentlichst du die Dokumentation oder gibst du mir nur Dateien?
Beides ist möglich. Basic und Reference werden als Markdown plus eine OpenAPI-Datei geliefert, die du selbst hostest. Full Docs beinhaltet eine funktionierende Dokumentationsseite, gebaut mit einem Static-Generator, bereit zum Deployment auf deiner eigenen Domain.
Wirst du die Dokumentation aktualisieren, wenn sich die API ändert?
Ja, als separater kleiner Auftrag. Schick mir das Changelog oder die Diff und ich aktualisiere die betroffenen Abschnitte. Da du die Quelldateien behältst, kann dein Team sie auch ohne mich pflegen.
