Algemeen
In deze handleiding wordt uitgelegd hoe je zelf aan de slag kan gaan met het maken van documentatie voor softwareprojecten.
Om documentatie te maken ,wordt gebruik gemaakt van Docfx. Docfx is een static site generator die Markdown bestanden omzet naar HTML.
De documentatie kan worden geschreven in Markdown language. Markdown is een lichtgewicht opmaaktaal met een eenvoudige syntaxis.
We raden aan om de documentatie te schrijven in Visual Studio Code. Visual Studio Code is een lichtgewicht code-editor die beschikt over een ingebouwde Markdown previewer.
De documentatie kan worden gepubliceerd op een Azure static website. Een Azure static website is een eenvoudige manier om statische websites te hosten. Hiertoe wordt de broncode van de website opgeslagen in een Github repository. De website wordt automatisch gebouwd en gepubliceerd bij elke commit op de master branch.
Stap1: Docfx installeren
Docfx installeren: Docfx.
Stap2 : Github repository aanmaken
Maak een Github repository aan om de documentatie te beheren. Github
Stap3: Nieuwe site aanmaken
Maak een nieuwe site aan met behulp van Docfx.
Stap4: Documentatie schrijven
Schrijf de documentatie in Markdown language.
Stap5: Azure Static Website aanmaken
Maak een Azure Static Website aan om de website te hosten. Azure Static Website
Stap6: Documentatie publiceren
Publiceer de documentatie op de Azure Static Website.
