📒 Références

Qu'est-ce qu'une référence ?

En savoir plus sur les références (EN)

TL;DR :
Une référence est une documentation technique qui fournit des informations complètes et détaillées sur un produit ou un système.
Elle sert de ressource principale pour les utilisateurs ayant besoin de données spécifiques, telles que des descriptions de commandes, de fonctions, d'API, etc..

C'est de l'information pure et dure, comparable à un dictionnaire.

Caractéristiques d'une bonne référence

• Complète : Couvre tous les aspects techniques du sujet.
• Structurée : Organisée de manière logique pour une recherche facile.
• Précise : Fournit des descriptions exactes et détaillées.
• Accessible : Facile à naviguer et à comprendre pour les utilisateurs techniques.

Exemple de référence

Vous savez que la mayonnaise c'est riche, mais pas de quelle manière ça l'est.

Informations nutritionnelles de la mayonnaise pour 100g ?

• Kilocalorie(s) : 645
• Kilojoule(s) : 2700
• Matières grasses : 0,07 g
• Indice (protéines/matières grasses) : 0,013
• dont Acides gras saturés : 5,90 g
• Glucides : 0,0029 g
• dont Sucres : 1,9 g
• Fibres : 0,5 g
• Protéines : 0,0009 g
• Sel : 1,80 g

En lisant cette référence vous prenez connaissance des informations nutritionnelles de la mayonnaise.