DocumentationAan de slag met documentatie


versies

Versie Publicatiedatum
Privé Beta 2016/03/26
1 2016/07/25
2 2016/08/04
3 2016/08/29
4 2016/09/12
5 2016/09/29
6 2016/10/20
7 2016/11/29

Over documentatie

Wat kan er gedocumenteerd worden?

  • Voorbeelden van functies voor verschillende talen.
  • Een korte introductie van elke tag.

Wat is het verschil tussen een vraag en een onderwerp?

  • Onderwerpen hebben een breder bereik dan vragen; documentatie-onderwerpen die als een vraag worden gesteld, kunnen worden gesloten omdat ze te breed zijn.
  • Onderwerpen moeten meerdere voorbeelden hebben; een verzoek dat kan worden bediend door een onderwerp met een enkel voorbeeld (bijvoorbeeld één codeblok) is waarschijnlijk te smal.

Hallo Wereld

Een hallo wereldonderwerp zou moeten bestaan uit het meest elementaire, complete, uitvoerbare startprogramma dat beschikbaar is, dat kan worden bereikt door het grootste aantal versies van de taal, het framework of het systeem dat wordt gedocumenteerd. Indien nodig moeten de opmerkingen basisinstructies bevatten voor het voorbereiden en uitvoeren van de voorbeelden.

Over het algemeen hoeven er niet meer dan een of twee voorbeelden te zijn, behalve in gevallen waarin latere versies van de taal niet achterwaarts compatibel zijn. Vergeet niet dat het hello-wereldonderwerp het startpunt zal zijn voor iedereen die net een taal begint te leren. Als zodanig moet het minimale werkvoorbeelden aantonen die een leerling kan gebruiken om een correct programma te bereiken. Het is niet noodzakelijk een plek om de nieuwste functies van een taal te demonstreren.