Elements de documentation

⌛  Temps de lecture estimé: 5 minutes

1. Blockquote
2. Bloc de code
3. Liste à puces
4. Liste numéroté
5. Liste cases à cochées
6. Bloc information (CTA)
7. Tableau
8. Schéma
9. Capture d'écran
10. Lien vers article

Blockquote

Un bloc de citation (blockquote) permet de mettre en valeur une phrase, un extrait ou une parole prononcée ou écrite par quelqu’un d’autre. Il sert à appuyer un propos, à illustrer une idée ou à partager une réflexion marquante. Par exemple, pour illustrer l’importance de la persévérance, on peut insérer un bloc de citation :

« Le succès est la somme de petits efforts répétés jour après jour. »
— Leo Robert Collier 

Bloc de code

Un bloc de code permet de présenter clairement un extrait de programme informatique ou une commande à exécuter. Il facilite la lecture et la compréhension du code en le distinguant visuellement du texte principal. Par exemple, pour afficher “Bonjour le monde” en Python, on peut utiliser un bloc de code :

print("Bonjour le monde")

Liste à puces

Une liste à puces sert à organiser des informations de manière claire et concise, facilitant ainsi la lecture et la compréhension des points clés. Par exemple, pour présenter les avantages d’une activité, on peut utiliser une liste à puces :

• Facile à organiser
• Met en évidence les idées principales
• Aide à retenir l’information

Liste numérotée

Une liste numérotée permet de présenter des informations dans un ordre précis ou de montrer une séquence à suivre. Cela aide à clarifier les étapes ou à hiérarchiser l’importance des éléments. Par exemple, pour expliquer comment préparer un café, on peut utiliser une liste numérotée :

1. Faire chauffer de l’eau
2. Mettre du café moulu dans le filtre
3. Verser l’eau chaude sur le café
4. Attendre que le café s’écoule
5. Servir et déguster

Liste cases à cochées ??

Une liste de cases à cocher permet de suivre l’avancement de tâches ou de s’assurer que toutes les étapes d’une procédure sont complétées. Elle est idéale pour les listes de vérification ou les to-do lists. Par exemple, pour préparer un sac de voyage, on peut utiliser une liste de cases à cocher :

☐ Mettre des vêtements
☐ Préparer des articles de toilette
☐ Prendre les documents de voyage
☐ Emporter chargeur et téléphone
☐ Ajouter les collations

Bloc d'information (nommé CTA dans Hubspot)

Un bloc d’information permet de mettre en avant une remarque, un conseil ou une précision importante dans un article. Il aide à attirer l’attention du lecteur sur un point clé sans alourdir le texte principal. L’ajout d’un titre au bloc (avec un emoji) facilite la compréhension et permet d’identifier rapidement la nature de l’information présentée.

Astuce

Un bloc d’information "Astuce" permet de mettre en avant un conseil ou une recommandation utile pour l’utilisateur. Il attire l’attention sur un détail qui peut faciliter la tâche ou améliorer le résultat. Par exemple, pour cuisiner du riz, on peut ajouter un CTA Astuce :

Notes

Un bloc d’information "Notes" sert à fournir des précisions, des informations complémentaires ou des remarques importantes à propos du sujet traité. Il permet d’ajouter des détails utiles sans alourdir le texte principal. Par exemple, lors de la prise de médicaments, on peut insérer un CTA Notes :

Attention

Un bloc d’information "Attention" permet de signaler un risque, un point de vigilance ou une mise en garde importante. Il attire l’œil sur un aspect à ne pas négliger pour éviter des erreurs ou des dangers. Par exemple, lors de l’utilisation de produits ménagers, on peut mentionner un CTA Attention :

Avertissement

Un bloc d’information "Avertissement" sert à prévenir l’utilisateur d’un danger potentiel ou d’une conséquence grave en cas de non-respect d’une consigne. Il souligne l’importance de suivre certaines règles pour assurer la sécurité. Par exemple, pour l’utilisation d’un appareil électrique, on peut intégrer un bloc Avertissement :

Tableau

Un tableau permet de présenter des informations de façon organisée et comparative, facilitant ainsi la lecture et la compréhension de plusieurs données en parallèle. Il est idéal pour regrouper des chiffres, des caractéristiques ou des résultats. Par exemple, pour comparer différents forfaits téléphoniques, on peut utiliser un tableau :

Schéma

Un schéma permet de visualiser rapidement des concepts, des relations ou des processus de manière graphique. Il facilite la compréhension d’informations complexes en les représentant visuellement. Par exemple, pour illustrer le cycle de l’eau, on peut utiliser un schéma :

Ce schéma montre les différentes étapes du cycle de l’eau (évaporation, condensation, précipitation, infiltration).

Capture d’écran

Une capture d’écran permet de montrer visuellement l’interface d’un logiciel, le résultat d’une action ou une étape précise d’une procédure. Elle aide l’utilisateur à mieux comprendre les explications écrites en affichant exactement ce qu’il doit voir à l’écran.

Liens vers article

Un lien vers un autre article permet de rediriger l’utilisateur vers des informations détaillées, des guides ou des solutions à des problèmes spécifiques. Ce type de lien facilite l’accès à une ressource externe fiable pour approfondir un sujet ou résoudre une question. Par exemple, pour en savoir plus sur la gestion des fichiers sources, on peut insérer un lien vers un article du centre d’aide directement dans le texte,  📄 Gestion des fichiers sources ou alors on peut le présenter dans un bloc d'information 'Notes' :