Ik schrijf developersdocumentatie met architectuuroverzicht en API-referentie
Oprichter bij P en A Dawn Works LLP
Over deze dienst
Documentatie die een nieuwe engineer daadwerkelijk kan gebruiken. We lezen jouw repository en leveren: een architectuuroverzicht met diagrammen (Mermaid, renders op GitHub), een setup-gids die een nieuwe medewerker in 30 minuten aan de praat krijgt, een API-referentie gegenereerd uit de code en handmatig gecontroleerd, en de vijf risicovoorzieningen van de codebase met wat je per gebied moet doen.
Opgeleverd als pull requests naar jouw docs-map (Markdown), of als een PDF voor investeerders en kopers.
Hoe het werkt: stuur de repository-link. Binnen 48 uur ontvang je gratis een watermerk-architectuuroverzicht-diagram van één dienst uit jouw repository. Plaats een bestelling pas als het klopt.
Vast bedrag per resultaat, nooit op uurbasis. P & A Dawn werkt, New Delhi.
Type document:
Documentatie
•
Technische specificaties
Branche:
Software
Taal:
Engels
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
Welke talen en frameworks kun je documenteren?
JavaScript, TypeScript, Python, Go, Java en C# codebases, met REST- of GraphQL-APIs. Diagrammen zijn Mermaid, zodat ze op GitHub renderen.
Moet ik jou schrijfrechten geven?
Nee. Leesrechten op de repository is genoeg. Docs komen aan als een pull request die je beoordeelt, of als een PDF.
Kan ik het werk zien voordat ik betaal?
Ja. Stuur de repository-link en binnen 48 uur krijg je gratis een watermerk-architectuuroverzicht-diagram van één dienst, nog voordat je een bestelling plaatst.
