Glossaire

Actions

Évaluer Distinguer

Distinguer les principales qualités du produit et, si nécessaire, le comparer à d’autres. Les utilisateurs de documentation sont aussi des clients ou adoptants potentiels. Un lecteur doit pouvoir distinguer les principales qualités du produit et le comparer à d’autres. C’est un processus de découverte.

Comprendre Apprendre

Saisir les abstractions et les modèles mentaux sur lesquels le produit est construit. Les produits logiciels sont construits autour d’abstractions difficiles à saisir mais fondamentales pour un bon usage. La documentation conceptuelle ancre les apprentissages aux côtés de l’exploration et de la pratique.

Explorer Découvrir

Essayer le produit et découvrir ce qu’il peut faire avec une faible barrière à l’entrée. Les grands produits invitent les utilisateurs à interagir et à essayer de nouvelles choses. La documentation devrait fournir des indices, des instructions et des possibilités d’action qui facilitent l’exploration, l’une des premières activités.

Pratiquer S’entraîner

Apprendre à utiliser le produit dans son exploitation quotidienne et courante. Les utilisateurs doivent apprendre à utiliser la plupart des parties d’un produit. Pratiquer décrit le besoin de connaissances procédurales : savoir employer le produit dans les opérations quotidiennes et courantes.

Se souvenir Rappeler

Retrouver des fragments d’information impossibles à mémoriser, des paramètres aux codes d’erreur. La référence maintient la documentation vivante après des années d’usage. Les utilisateurs parcourent les manuels pour se souvenir, rappeler, retrouver ou rechercher des informations qu’ils ne pouvaient mémoriser.

Développer Intégrer

Construire sur le produit, l’étendre ou l’intégrer afin de créer de la valeur supplémentaire. Les utilisateurs doivent souvent construire sur des produits existants, les étendre ou les intégrer — au moyen d’intégrations, d’extensions, de modules ou d’applications entièrement nouvelles. L’accent est presque toujours pragmatique.

Dépanner Résoudre

Diagnostiquer et résoudre efficacement les problèmes, souvent sous pression. Rencontrer des problèmes — mauvaises configurations, cas limites ou vrais bogues — est courant. Dépanner représente le besoin de les diagnostiquer et de les résoudre efficacement, souvent sous pression, quand les systèmes échouent ou que les échéances approchent.