Les références répondent à la question « Quoi ? », comme dans :
- Quelle valeur dois-je entrer ici ?
- Que cela signifie-t-il quand la LED clignote trois fois ?
- Quels paramètres de commande dois-je utiliser ?
- Quelles les valeurs de statut puis-je attendre de cet appel de fonction ?
- Que signifie ce message d’erreur ?
Les références fournissent des informations sur un point précis. Alors qu’un concept peut fournir des informations générales et répondre à la question « Pourquoi ? », la référence fournit des informations spécifiques. Les lecteurs habituels des références trouvent les informations dont ils ont besoin, puis poursuivent leur travail ; ils ne lisent ou ne consultent généralement pas d’informations supplémentaires.
Le format du contenu d’une référence est déterminé par l’organisme auteur et, idéalement, codifié dans un guide de style. Les exemples de cette leçon ne montrent qu’une seule façon d’organiser l’information.
Si les références peuvent contenir de nombreux éléments que nous avons déjà couverts dans les cours précédents, ce cours se concentrera sur les nouveaux.
Les références se répartissent en deux catégories générales :
-
Des rubriques uniques et autonomes contenant un petit nombre de tableaux ou de figures. En voici quelques exemples :
-
Tableaux matriciels des dispositifs et des valeurs ou tolérances spécifiques
-
Illustrations de ports et de la connectique de l’appareil
-
-
Plusieurs rubriques connexes qui fournissent des informations sur des points connexes, une rubrique par point. Ces rubriques ont généralement une structure parallèle, de sorte que le lecteur peut toujours trouver l’information. En voici quelques exemples :
- Référence de ligne de commande
- Référence de fonction API
- Référence de code d’erreur
- Fiche technique de l’appareil