Rédaction de documentation technique : la méthode par sujet
Dans le domaine de la documentation technique, on ne peut pas passer à côté de la méthode par sujet. Et ça consiste en quoi exactement?
Sujet autonome
Dans la méthode par sujet, chaque sujet doit être autonome. Ça signifie que, quand on développe un sujet, on doit en faire le tour de façon à répondre à toutes les questions qui le concernent (qui, quoi, comment, quand, pourquoi). Chaque sujet doit donc être complet en soi. Ainsi, on pourrait intégrer un sujet à différents contextes sans nuire à la cohérence de l’ensemble. Imaginez que votre documentation technique est un archipel, un groupe d’îles, dans lequel chaque sujet serait une île. Le sujet est indépendant, mais fait partie d’un ensemble.
Un besoin, un sujet
Pour bien cibler le contenu d’un sujet, il faut qu’il réponde à un besoin, ou à une question de l’utilisateur : « Par où est-ce que je commence? », « Quels concepts dois-je connaître pour comprendre le produit? », « Comment est-ce que je peux faire telle opération? », « Comment est-ce que je peux régler ce problème? », etc. Les réponses à ces questions deviennent les sujets à développer. Techniquement, un sujet devrait répondre entièrement à une question précise pour que l’utilisateur trouve toutes les réponses à une question à un seul endroit.
À la une
Dans l’approche par sujet, comme l’explique Mark Baker, il faut traiter « chaque page comme si c’était la première page ». Comme chaque sujet se suffit en lui-même, on ne peut pas savoir dans quel ordre l’utilisateur les consulte. On doit donc toujours mettre l’utilisateur en contexte. Cela implique parfois de répéter certains éléments d’un sujet à l’autre. L’important, c’est d’en dire assez pour mettre l’utilisateur en contexte et de fournir un sujet complet et autonome sans toutefois s’éloigner de l’objectif du sujet.
Un titre sensé
Le titre devrait décrire précisément le sujet développé. C’est le principal outil dont dispose l’utilisateur pour trouver le sujet qui répondra à ses questions. Trouver le bon titre peut donc être tout un défi! Il doit être à la fois précis, mais simple, résumer l’essentiel du sujet, mais aussi faciliter sa recherche.
Utilisateur libre
Avec la méthode par sujet, l’utilisateur peut aller chercher uniquement l’information dont il a besoin, sans avoir d’abord à consulter de l’information qui ne lui est pas directement utile. Comme le touriste qui visite un archipel et décide quelles îles il a envie de visiter et dans quel ordre, l’utilisateur choisit ce qu’il veut lire et quand il veut le lire.
Pour en savoir plus…
Every page is page one
