Premiers pas avec la documentation

À propos de la documentation

Que peut-on documenter ?

  • Exemples de fonctions pour différentes langues.
  • Une brève introduction de chaque balise.

Quelle est la différence entre une question et un sujet ?

  • Les sujets ont une portée plus large que les questions ; les sujets de documentation qui sont posés sous forme de question peuvent être fermés car ils sont trop larges.
  • Les sujets doivent avoir plusieurs exemples ; une requête qui peut être servie par un sujet avec un seul exemple (par exemple, un bloc de code) est probablement trop étroite.

Bonjour le monde

Un sujet hello world doit comprendre le programme de démarrage le plus basique, le plus complet et le plus exécutable disponible, qui peut être réalisé par le plus grand nombre de versions du langage, du framework ou du système documenté. Si nécessaire, les remarques doivent inclure des instructions de base sur la façon de préparer et d’exécuter les exemples.

Le sujet ne devrait généralement pas nécessiter plus d’un ou deux exemples, sauf dans les cas où les versions ultérieures du langage ne sont pas rétrocompatibles. N’oubliez pas que le sujet Hello World sera le point de départ pour quiconque commence à apprendre une langue. En tant que tel, il doit démontrer un minimum d’exemples de travail qu’un apprenant peut utiliser pour réaliser un programme correct. Ce n’est pas nécessairement un endroit pour démontrer les nouvelles fonctionnalités d’une langue.