Instruction file imported from RoelofvanLeeuwen/ToetsLocking (.github/instructions/readme.instructions.md). Copyright stays with the author.

README en documentatie instructies

Name: readme
Author: RoelofvanLeeuwen

Schrijf documentatie in deze repository in het Nederlands.

Doel

README-bestanden moeten praktisch en direct bruikbaar zijn voor ontwikkeling, setup, beheer en deployment.

Schrijfstijl

Schrijf helder en concreet.
Vermijd marketingtaal.
Leg stappen uit in logische volgorde.
Benoem aannames expliciet.
Houd documentatie compact, maar volledig genoeg om zelfstandig mee te werken.

Wat documenteren

Documenteer waar relevant:

architectuuroverzicht
projectstructuur
lokale ontwikkelsetup
EF Core migrations
Raspberry Pi setup
netwerkconfiguratie
deploymentstappen
runtime configuratie
bekende beperkingen en aandachtspunten

Stijlregels

Gebruik duidelijke koppen.
Gebruik codeblokken voor commando’s en configuratie.
Gebruik Nederlandstalige toelichting.
Geef concrete voorbeelden in plaats van algemene beschrijvingen.

Wat vermijden

Geen lange theoretische uitleg zonder praktisch nut.
Geen onnodige herhaling.
Geen Engelse README’s tenzij expliciet gevraagd.

{ "ocm": "1", "id": "roelofvanleeuwen-toetslocking-readme-instructions", "kind": "skill", "name": "readme", "description": "Schrijf documentatie in deze repository in het Nederlands.", "publisher": "RoelofvanLeeuwen", "version": "1.0.0", "capabilities": { "domains": [ "general" ], "tags": [ "skill-md", "github-instructions" ], "languages": [ "en" ] }, "quality_prior": 0.6, "examples": [ "Schrijf documentatie in deze repository in het Nederlands." ], "primary": false, "metadata": { "source": { "provider": "github-instructions", "repository": "https://github.com/RoelofvanLeeuwen/ToetsLocking", "path": ".github/instructions/readme.instructions.md", "ref": "df4ba2415c749d0a4f4c85dc28d1e335e68ccf31", "url": "https://github.com/RoelofvanLeeuwen/ToetsLocking/blob/df4ba2415c749d0a4f4c85dc28d1e335e68ccf31/.github/instructions/readme.instructions.md", "key": "RoelofvanLeeuwen/ToetsLocking/.github/instructions/readme.instructions.md" }, "applies_to": "README.md,**/README.md,docs/**/*.md" }, "instructions": "# README en documentatie instructies\n\nSchrijf documentatie in deze repository in het Nederlands.\n\n## Doel\nREADME-bestanden moeten praktisch en direct bruikbaar zijn voor ontwikkeling, setup, beheer en deployment.\n\n## Schrijfstijl\n- Schrijf helder en concreet.\n- Vermijd marketingtaal.\n- Leg stappen uit in logische volgorde.\n- Benoem aannames expliciet.\n- Houd documentatie compact, maar volledig genoeg om zelfstandig mee te werken.\n\n## Wat documenteren\nDocumenteer waar relevant:\n- architectuuroverzicht\n- projectstructuur\n- lokale ontwikkelsetup\n- EF Core migrations\n- Raspberry Pi setup\n- netwerk", "cost": { "context_tokens": 263 } }

readme

About

README en documentatie instructies

Doel

Schrijfstijl

Wat documenteren

Stijlregels

Wat vermijden

Use it

Manifest

Reviews