Rédiger en vue de la réutilisation

Il est conseillé d'opter pour un style ou une méthode de rédaction qui permette d'avoir un contenu réutilisable. Cette méthode a pour but de minimiser le contexte.

Dans un environnement faisant appel à une écriture linéaire, on a tendance à rédiger dans le contexte du document qu'on est en train de créer. Dans un environnement d'écriture modulaire, la rédaction doit se défaire de son contexte initial. Une rubrique modulaire peut être utilisée dans divers manuels et dans des contextes totalement différents. La description d'une carte mémoire pourra se retrouver dans un manuel d'appareil photo, dans le système d'aide d'un netbook ou encore dans le guide d'utilisation en ligne d'un téléphone portable.

Dans DITA, tout élément balisable peut être réutilisé via un conref. Cela signifie que des paragraphes (éléments block) ou des phrases (éléments inline) peuvent être réutilisés. Par exemple, un bloc note peut être utilisé dans plusieurs rubriques, voire plusieurs fois dans une même rubrique. De la même manière, une étape de procédure et un nom de produit peuvent être des éléments réutilisables.

Ainsi, dans un environnement de rédaction DITA, vous devez envisager la possibilité que tout ce que vous écrivez soit réutilisé. Vous devez éviter de donner un contexte à votre rédaction, puisque celui-ci empêche la réutilisation.

Par exemple, vous devez éviter les formulations telles que dans les paragraphes suivants, ou comme abordé plus tôt, ou dans le schéma ci-dessous.

Vous devez également éviter autant que possible, l'utilisation de références restrictives. Par exemple, une instruction d'étape telle que Cliquez sur Imprimer dans le volet de navigation situé à gauche restreint la réutilisation de cette étape aux seuls cas où le bouton Imprimer se situe dans le volet de navigation situé à gauche. Même si Cliquez sur Imprimer ou Cliquez sur Imprimer dans le volet de navigation peut faire perdre un peu en clarté, les avantages qu'apporte la réutilisation (dont l'efficacité de l'édition et de la traduction) en valent généralement la peine.

On pourrait penser qu'un tel compromis sur le style rédactionnel, dans le but d'améliorer les opportunités de réutilisation, entraîne une rédaction de qualité médiocre. Cependant, la rédaction de documents techniques est étroitement liée aux exigences des entreprises en matière de budgets et de délais. De tels compromis sont fréquents dans la documentation technique : celui entre le style rédactionnel et la réutilisation n'est donc qu'un compromis parmi d'autres.