Informations de transition dans les blocs sémantiques

Les en-têtes, les phrases d'introduction et les phrases de texte d'introduction ne devraient pas être utilisés pour introduire des blocs de texte sémantiques comme les pré-requis. Le processus de publication peut ajouter systématiquement les informations de transition nécessaires, permettant plus de cohérence et de simplicité.

Il ne faut pas inclure de texte de transition dans les éléments tels que les pré-requis (prereq), le contexte (context), le résultat (result) et les post-requis (postreq).

Il existe plusieurs cas dans lesquels le texte de transition est inclus à tort dans des blocs sémantiques, comme dans les exemples suivants :
  • Dans cette rubrique... (dans shortdesc)
  • Le système doit respecter les conditions suivantes avant de commencer la procédure... (dans context)
  • Avant d'entrer le code PIN, vous devez effectuer d'importantes vérifications... (dans prereq)
  • Après avoir terminé la procédure, vous trouverez... (dans postreq)
  • Dans cette procédure, les étapes pour... (dans context)

Dans DITA, des procédés alternatifs et une approche minimaliste sont préférés au texte de transition. Ces procédés incluent un processus de publication pouvant systématiquement appliquer des labels à des parties du document de sortie. Par exemple, les mots Avant de commencer et une icône graphique peuvent être insérés avant tous les éléments pré-requis prereq dans le document de sortie. Cette labellisation systématique et cohérente permet au lecteur d'identifier facilement les éléments sémantiques.

Si votre processus de publication traite les éléments sémantiques tels que postreq de la même manière que les éléments de paragraphe (p), vous devriez changer votre processus de publication pour que celui-ci génère des informations de transition. Cela vous évitera de changer votre approche rédactionnelle et d'inclure des informations de transition redondantes dans votre contenu.

N'incluez pas de libellés tels que Remarque, dans le texte des éléments d'avertissement. Le libellé et le formatage approprié s'appliquera lors de la publication du document.