Een README maken met reproduceerbare installatie.
Een README moet installatie reproduceerbaar maken vanuit geverifieerde eisen. Onderscheid gecontroleerde instructies van voorgestelde commando’s of ontbrekende configuratie.
Stem de werkwijze af op je taak.
Gebruik echte scripts, vereisten en configuratie uit de repository om installatie en eerste gebruik uit te leggen. Scheid geverifieerde commando’s van voorgestelde stappen, houd geheimen uit voorbeelden en geef een duidelijke route naar testen.
- Wat je aanlevert
- Geverifieerd projectgedrag en installatievereisten.
- Wat je krijgt
- Projectdocumentatie met uitvoerbare stappen die verificatie vereisen.
Bekijk de invoer en het resultaat.
Illustratieve invoer en uitvoer · een leervoorbeeld, geen live uitvoering van WebAct
Voorbeeld invoerveld
Write a minimal README. Fictional project: Tiny Notes. Requires Node 24 and npm, has package-lock.json, scripts dev and test, no environment variables needed for local use.
Uitgewerkt voorbeeld
# Tiny Notes A small notes application. ## Requirements Node 24 and npm. ## Local setup Install locked dependencies with `npm ci`. Start development with `npm run dev`, then open the URL printed by the development server. ## Tests Run `npm test`. ## Configuration No environment variables are required for local use. These instructions reflect the supplied project facts; no repository execution is claimed.
Laad deze invoer in de prompt en kopieer deze naar WebAct om de taak te proberen. Je resultaat kan afwijken van het voorbeeld.
Keuzes en probleemoplossing.
Moet een README een installatiecommando verzinnen dat gebruikelijk klinkt?
Controleer eerst het project. Een bekend commando kan verkeerd zijn voor de gebruikte pakketbeheerder, lockfile of het bouwproces.
Waarom mislukt installatie ondanks het volgen van de README?
Vergelijk runtimeversies, vereiste configuratie en echte scripts. Reproduceer de ontbrekende stap in plaats van een vage probleemoplossingsparagraaf toe te voegen.
Probeer het met je eigen bron.
Vervang het voorbeeld door je eigen materiaal in de taakprompt. Behoud de eisen die je nodig hebt en kopieer de taak naar WebAct.
De taak aanpassen en kopiëren ↑