0 Minuten lezen
0 Min
1 dec 2022
Welkom terug bij onze tweede blog over rapportagetips. Als je de eerste blog over het instellen van de ernst van een rapport met de CVSS-calculator hebt gemist, maak je geen zorgen, je kunt het nog steeds hier bekijken!

Als onderzoeker wil je dat je rapporten duidelijk worden begrepen en goed worden ontvangen. Een van de manieren om deze doelen te bereiken, is door je rapport visueel aantrekkelijk te maken. Om je rapport er beter uit te laten zien en in dat proces gemakkelijker leesbaar te maken, ondersteunt het Zerocopter-platform Markdown.

Markdown is een lichtgewicht opmaaksysteem om opgemaakte tekst te creëren. Met markdown kun je koppen aan je rapport toevoegen, de tekst vet makenof cursief maken, en zelfs codeblokken of inline codefragmenten toevoegen. Deze laatste twee zijn bijzonder handig, bijvoorbeeld om gehele verzoeken en antwoorden in je code te plaatsen, of om ervoor te zorgen dat een lange URL leesbaar blijft. 

De meest nuttige opmaakopties zijn:

  • *vet* : Maakt de tekst vet

  • **cursief** : Maakt de tekst cursief

  • > geciteerd tekst : Creëert een citaat

  • – lijstitem : creëert een ongesorteerde lijst

  • `inline code` : een inline stuk code

  • “` Codeblok : creëert een codeblok‍

Met de bovenstaande notatie kun je een rapport er gemakkelijk zo uit laten zien:

Dit maakt het veel aangenamer om te lezen en gemakkelijker te begrijpen dan een muur van tekst zonder enige opmaak. 

Als je meer wilt lezen over Markdown, heeft GitHub een nuttige referentiegids / spiekbrief hier.