Aperçu des références

Aperçu

Reference regroupe les documents courts et orientés règles qui ne trouvent pas leur place dans un guide de configuration étape par étape. Utilisez cette section pour vérifier rapidement des faits durables, des contraintes, la terminologie et des résumés du comportement du produit utiles aux utilisateurs et aux équipes d’assistance.

Cette section ne doit pas devenir un deuxième système de guides. Les guides restent séparés de la documentation produit. Reference complète les autres sections en rendant les faits importants faciles à retrouver.

Ce qui figure dans Reference

Les bons sujets pour Reference comprennent notamment :

• les matrices de comportement des workflows ;
• les résumés de forfaits, d’utilisation et de limites ;
• les règles de planification du calendrier ;
• les règles de vérification des commandes et des paiements ;
• la terminologie propre à la documentation Interlinked, lorsqu’elle fonctionne comme un glossaire ;
• les références de fonctionnalités publiques utiles aux clients ou aux équipes d’assistance.

Les pages Reference doivent rester factuelles, faciles à parcourir et stables. Si un sujet explique comment accomplir une tâche, il appartient probablement à une section produit.

Comment Reference aide la recherche et la récupération LLM

Les pages Reference sont utiles à la recherche et aux exports LLM, car elles regroupent les règles exactes en un seul endroit. Par exemple, les informations de Calendrier : notes et comportements importants sont plus faciles à retrouver lorsqu’un utilisateur ou un LLM a besoin d’un résumé concis du comportement de planification.

Lorsque vous ajoutez une page Reference, choisissez un titre explicite et évitez les noms vagues comme « Notes » ou « Divers ». Préférez un titre qui indique le domaine produit et le type de règle.

Conseils de maintenance

Les pages Reference doivent être revues lorsque le comportement du produit change. Elles résument souvent des règles utilisées par d’autres articles : une information de référence inexacte peut donc créer de la confusion dans toute la documentation.

Documentation connexe

Utilisez cette page avec Aperçu des workflows, Calendrier : notes et comportements importants et Vérification et sécurité des paiements.