Learn Documentatie schrijven - aliconnect/aliconnect.sdk GitHub Wiki

Hoe schrijf je documentatie

  • We schrijven documentatie in een text formaat zodat deze gelezen kan worden platform onafhankelijk met een eenvoudige text editor en dus altijd te lezen. We schrijven dus niet in MS-Word.
  • Documentatie in de wiki wordt niet geinstalleerd op een systeem
  • Alle wiki documentatie is alleen online beschikbaar
  • Alle wiki documenten staan in de root van de wiki folder
  • bestandsnamen hebben nooit een _ of een , alle woorden zijn gescheiden door een - teken.
  • documentatie in het project is altijd geschreven in een README.md bestand