Door categorieën bladeren
Ontdekken
Fiverr Pro
Nederlands
$
USD
Ik documenteer je software met architectuurdiagrammen en swagger openapi docs
Full Stack ontwikkelaar
Full Stack ontwikkelaar met het vermogen om te leren en te begrijpen, zodat ik de problemen kan doorgronden en de oplossingen kan bieden die jouw bedrijf nodig heeft.
Over deze dienst
Maak je software makkelijker te begrijpen, te onderhouden en over te dragen aan andere ontwikkelaars. Ik zet je broncode en projectinformatie om in duidelijke technische documentatie, met behulp van AI-ondersteunde analyse en een review op basis van de aangeleverde materialen.
BASIS: 1 module, projectoverzicht, structuur, setup-gids en 1 architectuurdiagram. Markdown-levering.
STANDAARD: tot 3 modules, kernworkflows en datamodel, tot 3 diagrammen en Swagger/OpenAPI voor 10 endpoints. Markdown en PDF.
PREMIUM: tot 6 modules, gedetailleerde workflows en datamodel, tot 6 diagrammen en OpenAPI voor 25 endpoints. Setup/deploy-gids op basis van jouw aangeleverde omgeving. Markdown, PDF en bewerkbare diagrambronnen.
Een module is een afgesproken functioneel gebied, zoals authenticatie of betalingen. Een endpoint is één HTTP-methode plus route. Alle limieten gelden samen voor één repository en een afgesproken codeversie.
Revisies dekken correcties binnen de afgesproken scope. Nieuwe functies, codewijzigingen, runtime testen en doorlopende updates vereisen een aparte offerte. Neem contact met me op voordat je bestelt voor grote of complexe projecten.
Veelgestelde vragen
Automatische vertaling
Wat heb je nodig om te beginnen?
Lever de broncode of repository, taal/framework, afgesproken codeversie, modules en endpointaantal, beoogde lezers en beschikbare setup/deploy-informatie. Verwijder wachtwoorden, API-sleutels en persoonlijke gegevens voordat je deelt.
Gebruik je AI om de documentatie te maken?
Ja. Ik gebruik AI-ondersteunde analyse om de documentatie voor te bereiden en te beoordelen op basis van de code en informatie die je aanlevert. Ontbrekend of onduidelijk gedrag wordt gemarkeerd voor verduidelijking. Runtime testen is een aparte dienst.
Wat telt als een module of endpoint?
Een module is een afgesproken functioneel gebied, zoals authenticatie of betalingen. Een endpoint is één HTTP-methode en route. Package-limieten gelden samen voor één repository en codeversie. Grotere systemen vereisen een aangepaste offerte.
Wat zit er in revisies?
Revisies dekken correcties en verduidelijkingen binnen de afgesproken scope en codeversie. Nieuwe modules, functies, codewijzigingen, extra endpoints of doorlopende documentatie-updates vereisen een aparte offerte.
