Ik schrijf technische documentatie, readme en API-documentatie voor je project
AI automatisering en full stack developer
Over deze dienst
Je project werkt. Het probleem is dat niemand het kan gebruiken zonder jou eerst drie vragen te stellen.
Ik ben een full-stack ontwikkelaar, dus ik lees je code voordat ik erover schrijf. Je hoeft je eigen project niet regel voor regel uit te leggen.
WAT JE KRIJGT
- Een README dat de vier vragen beantwoordt in volgorde: wat is dit, hoe installeer ik het, hoe run ik het, wat doe ik als het kapot gaat
- Installatiestappen die ik daadwerkelijk heb gevolgd, met echte prerequisites en versies, geen giswerk
- Elke omgevingsvariabele in een tabel: wat het doet, vereist of niet, een veilig voorbeeld
- API-referentie met methode, pad, authenticatie, parameters, een echte request en een echte response
- Elke foutcode die je service kan teruggeven, en wat de caller ermee moet doen
- Uit te voeren voorbeelden in curl en JavaScript, getest in plaats van slechts illustratief
STACKS die ik comfortabel lees
JavaScript, TypeScript, React, React Native, Node.js, Express, PostgreSQL, Supabase, n8n workflows, REST en webhooks.
Geleverd als Markdown, klaar om te committen, of als een documentatiesite op het Premium pakket. Ik schrijf in het Engels en in Braziliaans Portugees, en ik kan beide versies van hetzelfde document leveren.
Type document:
Documentatie
•
Technische specificaties
Branche:
Software
Taal:
Engels
•
Portugees
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
Moet ik je mijn hele codebase uitleggen?
Nee. Geef me toegang tot de repository of een zip-bestand, en ik lees het. Ik kom terug met een korte lijst vragen waar de code niet zelf op kan antwoorden.
Is mijn code vertrouwelijk?
Ja. Ik hergebruik, publiceer of deel geen klantcode, en ik ben graag bereid een NDA te ondertekenen voordat je iets stuurt.
Kun je een private of interne API documenteren?
Ja. Als er een collectie is (Postman, Insomnia, OpenAPI), stuur die dan. Als die er niet is, lees ik de routes.
Kun je zowel in het Engels als in het Portugees schrijven?
Ja. Vraag om de tweetalige levering en je krijgt beide versies van hetzelfde document.

