Door categorieën bladeren
Ontdekken
Fiverr Pro
Nederlands
$
USD
Ik schrijf API-documentatie, openapi swagger specificatie, ontwikkelaarsgidsen en SDK-documenten
Technische documentatie en data automation voor software teams
Ik ben software engineer. Ik schrijf de documenten die software teams nodig hebben en niemand wil schrijven: requirements specificaties, API-referenties, gebruikershandleidingen, runbooks. En ik autom...
Over deze dienst
Schrijf me gerust in het Italiaans.
De meeste API-documentatie wordt geschreven door iemand die de code niet kan lezen. Daarom wordt het na drie weken verouderd, en vragen je gebruikers nog steeds tickets aan met de vraag wat de foutcodes betekenen.
Ik ben een software engineer. Stuur me de repository, de Postman-collectie of het routebestand - ik lees het zelf en schrijf documentatie die precies aangeeft wat de service daadwerkelijk doet.
WAT JE KRIJGT
- Elke endpoint: methode, pad, authenticatie, parameters, request en response
- Echte foutresponses, met uitleg over de oorzaak en wat je eraan kunt doen
- Eén werkend voorbeeld per endpoint, in curl en in een taal naar keuze
- Een geldig OpenAPI 3-bestand, zodat de docs opnieuw gegenereerd kunnen worden nadat je de code hebt aangepast
- Een gepubliceerde docs-site op Redoc, Swagger UI of Mintlify (Premium)
REST, GraphQL, webhooks en SDKs. Ik heb nooit je productie keys nodig.
Als je API problemen heeft met naming of error handling, zeg ik dat voordat ik begin met schrijven. Documenteren van een verwarrende API maakt de verwarring alleen maar officieel.
Type document:
Documentatie
•
Technische specificaties
Branche:
Software
Taal:
Engels
•
Italiaans
Voorkeur voor een leveringsstijl
Laat het de freelancer weten als je voorkeuren voor of zorgen hebt over het gebruik van AI-tools voor het voltooien en/of leveren van je bestelling.
Mijn portfolio
Veelgestelde vragen
Automatische vertaling
Wat heb je nodig om mijn API te documenteren?
Een van deze: een repository, een Postman-collectie, een GraphQL-schema, een bestaand OpenAPI-bestand of een sandbox-sleutel. Als je er geen hebt, is een schermdeling waarbij je me door de calls leidt genoeg om te beginnen.
Publiceer je de docs, of geef je me alleen de bestanden?
Beide is mogelijk. Basic en Reference worden geleverd als Markdown plus een OpenAPI-bestand dat je zelf host. Full Docs bevat een werkende documentatiesite, gebouwd met een static generator, klaar om te deployen op je eigen domein.
Houd je de docs up-to-date als de API verandert?
Ja, als een aparte kleinere opdracht. Stuur me de changelog of de diff en ik werk de getroffen secties bij. Omdat je de bronbestanden bewaart, kan je eigen team ze ook onderhouden zonder mij.
