Sous-étapes au sein des étapes

Les rubriques de tâche autorisent deux niveaux d'étapes au sein d'une même procédure : étapes et sous-étapes. Il vaut mieux éviter les sous-étapes.

Dans DITA, les étapes procédurales peuvent être organisées en deux niveaux : steps et substeps. Toute étape d'un bloc steps peut être divisée en éléments substeps, mais il n'est pas possible de diviser un élément substep.

Si une étape procédurale est subdivisée, la section substeps peut être utilisée dans une section individuelle (comme élément fils de l'élément cmd). Dans les autres cas, il peut être utile d'adopter une structure choicetable qui pointera vers le choix dans une étape.

L'élément substeps contient un ou plusieurs éléments substep, quasiment identiques à l'élément step.

Évitez les substeps autant que possible. Si une étape est une tâche en soi, mieux vaut décrire cette tâche secondaire dans une rubrique séparée et faire une référence croisée de la rubrique principale vers la rubrique de la tâche secondaire. Dans l'idéal, votre tâche ne sera composée que d'un seul niveau d'étapes. Il est parfois nécessaire de réécrire une procédure pour trouver comment la simplifier en un seul niveau.

Si vous documentez une procédure qui contient deux variantes ou plus, par exemple une procédure pour activer JavaScript dans différents navigateurs, vous devriez créer une rubrique de tâche distincte pour chaque variante. Par exemple, vous devriez créer une rubrique pour Activer JavaScript dans Internet Explorer, une autre pour Activer JavaScript dans Safari et ainsi de suite.

Si la différence entre les procédures est très restreinte, il est possible d'écrire une seule procédure en utilisant les éléments choices ou choicetable pour indiquer les différences.