Ik maak technische documentatie voor je bestaande applicatie
Cloud applicatie ontwikkelaar, AI automater, fotograaf
Over deze dienst
Duidelijke, ontwikkelaarsvriendelijke documentatie die echt gelezen wordt.
Of je nu een gepolijste README, een uitgebreide API-referentie of een volledige documentatieset voor je applicatie nodig hebt, ik verzorg het schrijven zodat jij je kunt richten op bouwen.
Wat ik meebreng naar elk project:
- Ervaring met documentatie van REST API's, SDK's, CLI's en webapplicaties
- Bekendheid met Markdown, OpenAPI/Swagger en Github (voor sjablonen)
- Schoon, gestructureerd schrijven dat is afgestemd op je doelgroep: ontwikkelaars, eindgebruikers of beiden
Alle opleveringen zijn:
- Goed georganiseerd en gemakkelijk te navigeren
- Geschreven in eenvoudige, precieze technische Engels
- Opgemaakt volgens je bestaande style guide of een standaardconventie
Voordat we beginnen, bekijk ik je codebase, API-specificatie of bestaande docs om zeker te zijn dat alles correct en compleet is.
Heb je een project in gedachten? Stuur me een bericht en laten we praten.
Type document:
Documentatie
•
Standaard werkprocedures
Branche:
Software
Taal:
Engels
•
Frans
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.
Veelgestelde vragen
Automatische vertaling
Wat heb je van mij nodig om te beginnen?
Minimaal toegang tot je codebase, API-specificatie (bijvoorbeeld OpenAPI/Swagger) of bestaande docs. Hoe meer context je vooraf deelt, hoe nauwkeuriger de output wordt.
Kun je een API documenteren zonder een specificatiebestand?
Ja, ik kan direct werken vanuit je codebase, Postman-collecties of een werkende API. Voorbeeldverzoeken en -antwoorden helpen daarbij enorm.
In welk formaat wordt de documentatie geleverd?
Standaard lever ik Markdown (.md) bestanden die klaar zijn om in je repo of documentatieplatform te plaatsen. Ik kan ook HTML, PDF of elk ander formaat leveren dat je aangeeft.
Behandel je interne of privé documentatie?
Ja, ik heb interne ontwikkelaarsgidsen, runbooks en onboarding docs geschreven, naast openbare API-referenties en gebruikersgidsen. Alles wordt standaard als vertrouwelijk behandeld.
