Utiliser les sous-étapes de manière approprié

L’élément DITA <substep> peut-être utile, mais il doit être appliqué avec modération.

Si vous constatez que vous utilisez beaucoup de sous-étapes ou que vous avez des sous-étapes très longues, vous voudrez peut-être revoir votre analyse des tâches. Réfléchissez bien à la manière dont vous avez divisé vos principales tâches en rubriques de type tâche. Il se peut que vous n’ayez pas suffisamment divisé les tâches principales.

Autre signe clair que votre analyse des tâches n’est pas complète : vous utilisez de nombreuses sous-étapes et vous constatez fréquemment la nécessité de sous-étapes.

Les sous-étapes ne doivent être utilisées que dans un petit nombre de situations, comme par exemple :

  • Vous vous trouvez face à une étape complexe, où les lecteurs pourraient bénéficier de détails supplémentaires.

  • Votre public comprend des lecteurs novices qui pourraient bénéficier de conseils supplémentaires. La plupart des lecteurs comprendront tout ce que l’élément <cmd> leur indique de faire, mais certains lecteurs moins expérimentés auront peut-être besoin d’être éclairés un peu plus en détail avec des sous-étapes.

    Certains types de sortie peuvent vous permettre de masquer les sous-étapes qui fournissent des détails supplémentaires jusqu’à ce que le lecteur demande plus d’informations.

  • Les procédures dont les étapes ne sont pas homogènes. Vous rencontrerez parfois une tâche dont la plupart des étapes nécessitent un niveau d’explication cohérent, mais dont une ou deux étapes – bien qu’au même niveau que les autres – exigent beaucoup plus de détails.

Faites attention en utilisant les sous-étapes là où les éléments <choice> ou <choicetable> sont plus appropriés.

Contributeurs