Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 1.88 KB

README_AFTER_CLONE.md

File metadata and controls

51 lines (31 loc) · 1.88 KB

Specificatie

Dit is de GitHub-repository voor ...


Instructies voor redacteurs

  1. Werkversies

    Werkversies worden continu gepubliceerd op `https://docs.crow.nl/{{repository-korte-naam}}/{{document-korte-naam}} (logboek op auto-publish).

  2. Referentieversies

    Bijvoorbeeld voor een review of consultatie; klik op Publiceer een bepaalde versie en vervolgens Run workflow.

  3. Een nieuw document toevoegen

    Bijvoorbeeld voor een conceptueel model, API-beschrijving of uitwisselingsformaat; klik op Voeg een nieuw document toe en kies Run workflow.

  4. Publicatie op crow.nl

    Voor op de startpagina van docs.crow.nl: zie de README van docs.crow.nl. Voor op crow.nl of de kennisbank: mail.

  5. Werken met ReSpec

    ReSpec biedt structuur en presentatiemogelijkheden voor technische specificaties. Zoals informatiemodellen, uitwisselingsstandaarden en API-documentatie.

    ReSpec gebruikt GfM als Markdown-specificatie. Lees ter referentie de CROW-ReSpec-wiki en de algemene ReSpec-handleiding.

  6. Werken met Git en GitHub

    Er zijn talloze handleidingen voor Git en GitHub.

    De webinterface van VS Code (druk op GitHub.com op .) of Visual Studio Code geïnstalleerd op je computer. Voor VS Code worden er ook aanbevolen extensies meegegeven in deze repository.

  7. Bijlagen, zoals afbeeldingen

    Gebruik SVG-bestanden, bijvoorbeeld bewerkt met draw.io.