Ik schrijf API-documentatie met elk codevoorbeeld uitgevoerd en geverifieerd
Over deze dienst
De meeste gepubliceerde API-documentaties zijn nooit uitgevoerd. Voorbeelden wijken af van de bibliotheek naarmate deze versies krijgt, en door AI gegenereerde docs bevatten plausibel klinkende oproepen tegen een API die niet langer die signature heeft.
Ik schrijf documentatie waarbij elk codevoorbeeld tegen een vastgestelde versie wordt uitgevoerd voordat deze wordt vrijgegeven, en je ontvangt het verificatiescript naast de docs, zodat je het zelf opnieuw kunt uitvoeren en de output ziet.
WAT JE Krijgt
- Documentatie geschreven tegen jouw daadwerkelijke bibliotheek, niet tegen de README
- Elk voorbeeld uitgevoerd tegen de genoemde versie, met de output vastgelegd
- Het verificatiescript, zodat het bewijs van jou is en herhaalbaar
- Een notitie van alles wat ik niet kon verifiëren, en waarom nooit een stil stilstaand resultaat
WAT DIT NIET IS
- Geen garantie dat jouw gebruikers geen problemen zullen ondervinden
- Geen herschrijving van de ontwerprichtlijnen van jouw product
- Geen SEO-tekst of marketingcopy
ZIEN VOORDAT JE KOOPT
Vijf complete voorbeelden zijn gepubliceerd en gratis te lezen zonder aanmelding. Links in de FAQ hieronder.
Vertel mij de bibliotheek, de versie en welke onderdelen het meest relevant zijn voor jouw gebruikers.
Type document:
Documentatie
Taal:
Engels
•
Hebreeuws
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
Kan ik eerst jouw werk zien?
Ja — vijf complete voorbeelden, gratis, zonder aanmelding: Zod v4 validatiegedrag: https://devdocsstudio-debug.github.io/verity-works/sample-zod-v4.html betere-sqlite3 algemene patronen: https://devdocsstudio-debug.github.io/verity-works/sample-better-sqlite3.html pdf-lib snelle referentie: https://devdocss
Wat betekent "uitgevoerd"?
Elk voorbeeld wordt uitgevoerd tegen de versie die jij opgeeft, bij een schone installatie, en de output wordt vastgelegd. Als een voorbeeld niet kan worden uitgevoerd, wordt het niet als uitgevoerd meegestuurd — er zit een notitie bij wat er misging.
Wat als mijn bibliotheek verandert?
Het verificatiescript is van jou. Voer het opnieuw uit tegen de nieuwe versie en het vertelt je welke voorbeelden gebroken zijn.
Welke talen?
JavaScript- en TypeScript-bibliotheken en API’s.
Wat als iets niet verifieerbaar is?
Het wordt geleverd met een geschreven notitie waarin dat staat en waarom. Ik geef liever een gedocumenteerde kloof dan een zin die er gecontroleerd uitziet maar niet klopt.

