Ik schrijf een duidelijke readme en setup-gids voor jouw webproject
Over deze dienst
Geef ontwikkelaars een duidelijke starting point voor jouw kleine webproject.
Ik documenteer één afgesproken project met maximaal 5 relevante bron/configuratiebestanden en in totaal 500 regels niet leeg. Elke pakket gebruikt dezelfde codeomvang; hogere niveaus voegen diepte aan de documentatie toe.
Basis: README tot 800 woorden, vereisten, installatie, één gebruiksvoorbeeld en verificatiestukken.
Standaard: tot 1.400 woorden verdeeld over README en probleemoplossingsteksten, met maximaal 3 afgesproken gebruiksvoorbeelden.
Premium: tot 2.000 woorden verdeeld over README, installatie/probleemoplossing en ontwikkelaarshandover-notes, met maximaal 5 afgesproken voorbeelden.
Ik controleer claims tegen de opgegeven versie en verifieer veilige, afgesproken lokale stappen in één omgeving. Onverifieerde stappen en ontbrekende vereisten worden duidelijk gemarkeerd. Leveringen zijn bewerkbare Markdown-bestanden.
AI ondersteunt het opstellen; ik valideer de documentatie handmatig. Referenties, persoonlijke gegevens, broncode en vertrouwelijke materialen worden niet naar AI-tools gestuurd zonder schriftelijke toestemming van tevoren.
Geen codefixes, geen uitrol, geen betaalde services, geen beveiligingsaudit of volledige API-referentiesite. Stuur de projectscope en stack voordat je bestelt. Engels of Nederlands; één scoped revisie.
Type document:
Documentatie
Branche:
Software
Taal:
Nederlands
•
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
Hoe groot kan mijn project zijn?
Alle pakketten behandelen één project met maximaal 5 relevante bron/configuratiebestanden en in totaal 500 regels niet leeg. Leveranciers-, gegenereerde en geminified bestanden vallen niet onder de beoordeling. Hogere pakketten vergroten de documentatiediepte, niet de repositorygrootte. Stuur eerst de bestandslijst en stack zodat ik kan controleren of het past.
Welke items tellen mee voor de woord- en voorbeeldlimieten?
Basis bevat één README tot 800 woorden en één gebruiksvoorbeeld. Standaard bevat tot 1.400 woorden in totaal en 3 voorbeelden. Premium bevat tot 2.000 woorden in totaal en 5 voorbeelden. Dit zijn limieten, geen doelstellingen; de documenten kunnen korter zijn als dat het project duidelijk maakt.
Ga je mijn project draaien of documenteer je een programmeertaal?
We stemmen eerst een ondersteunde stack, versie en één lokale omgeving af. Ik verifieer veilige stappen binnen de scope; geen onveilig code, geheimen of betaalde services. Ontbrekende afhankelijkheden en unverifieerbare stappen worden duidelijk vastgelegd. Ik beloof niet elke technologie of elk besturingssysteem.
Ga je bugs oplossen, het project uitrollen of volledige API-documentatie schrijven?
Nee. Ik documenteer de afgesproken versie en geef verificatiestukken. Code-herstellingen, extra functies, deployment, productie-toegang, volledige API-referentiesites, beveiligingsbeoordelingen en extra omgevingen vallen buiten de scope. Bestaande problemen kunnen wel gedocumenteerd worden zonder te claimen dat ze opgelost zijn.
Kun je privécode gebruiken en gebruik je AI?
Deel alleen geautoriseerde code en verwijder geheimen en persoonlijke gegevens. AI kan helpen bij het opstellen; ik valideer de documentatie handmatig tegen de bron en goedgekeurd testen. Broncode en niet-openbaar materiaal worden niet zonder schriftelijke toestemming naar externe AI gestuurd. Maak vooraf afspraken over hoe je met vertrouwelijke materialen omgaat.
Welke bestanden, talen en revisies ontvang ik?
Bewerkbare Markdown-bestanden, een wijzigingssamenvatting en verificatiestukken, in Engels of Nederlands. Eén revisie dekt correcties of verduidelijking voor de oorspronkelijke versie, bestanden, voorbeelden en omgeving. Nieuwe versies, functies of omgevingen vereisen een aparte overeenkomst.

