Rubriques
Divers types de rubriques Une rubrique est destinée à représenter une unité d’information logique indépendante, qui peut être créée, stockée, gérée, distribuée et réutilisée séparément. existent. Cela a une incidence directe sur ce que vous pouvez écrire et sur la façon dont vous pouvez écrire votre contenu.
Qu’est-ce qui constitue une rubrique?
En règle générale, les rubriques doivent avoir un titre et contenir des informations qui peuvent être comprises de manière isolée et utilisées dans plusieurs contextes. Il doit être suffisamment concis pour ne référer qu’à un seul rubrique ou à une seule question, mais assez long pour être logique et écrit en tant qu’’unité autonome. Cela dit, les rubriques peuvent ne contenir que des titres et être utilisées dans le cadre d’une fonctionnalité particulière de la publication dans son ensemble, comme pour regrouper d’autres sous-rubriques dans une table des matières.
Types normalisés
- Concept : un concept est une rubrique où vous fournissez des explications sur le fonctionnement général d’un élément donné. Ces rubriques contiennent le côté théorique de votre contenu. Les concepts sont souples, ce qui permet d’utiliser des tableaux, des images, des listes, etc. Vous pouvez structurer votre contenu avec des sections à l’intérieur d’un concept. Cependant, vous ne pouvez utiliser qu’un seul niveau de section (une section ne peut pas contenir de sous-sections).
- Tâche : une rubrique de tâche vous permet de consigner des procédures et des actions. Ces rubriques font généralement suite aux rubriques de concept, puisqu’elles décrivent le côté pratique de votre contenu. Les rubriques de tâches comptent parmi les rubriques les plus restreintes : vous ne pouvez y énumérer que les mesures à effectuer, ainsi que les choix et les résultats des étapes facultatives. Elles permettent tout de même une présentation de contexte au début de la rubrique, ainsi qu’une liste des préalables.
Une documentation technique porte généralement sur la façon dont l’utilisateur peut effectuer des actions, de sorte que les rubriques de tâche ont tendance à être la pierre angulaire de votre document.
- Référence : une rubrique de référence vous permet de fournir la liste complète des éléments à titre de référence. Ces rubriques constituent la partie dictionnaire de votre contenu; il peut s’agir d’une liste de termes avec des définitions, d’une table de codes d’erreur, d’une liste de logiciels compatibles, etc. La référence est une rubrique flexible dans laquelle vous pouvez structurer votre contenu comme vous le souhaitez, avec un tableau, des listes et d’autres structures de division, comme une structure à base de sections, ou une structure de type liste de définitions. Cependant, lorsque vous commencez à utiliser une structure, vous devez vous y tenir à l’échelle de la rubrique.
Ces types normalisés permettent une spécialisation accrue pour en faire un type de rubrique normalisé spécialisé ou un type de rubrique personnalisé.
Types personnalisés
Chaque organisation peut créer ses propres types de rubriques, créer des modèles qui déterminent la structure interne et les éléments obligatoires qui doivent être utilisés dans la rubrique.
- Des feuilles de style qui rendent certains éléments obligatoires ou interdits dans les rubriques.
- Des modèles qui produiront des rubriques renseignées avec des éléments spécifiques.
Par exemple, votre organisation pourrait définir un modèle qui renseigne de nouvelles rubriques avec un paragraphe, une image et un tableau, et rendre tout autre élément interdit. Dans un tel cas, tous les auteurs devront adapter le contenu au format autorisé; il ne sera pas possible de créer des sections, des étapes de tâches ou tout autre élément que ceux déjà dans la nouvelle rubrique. Bien sûr, les feuilles de style et les modèles peuvent aussi être beaucoup plus flexibles.
C’est pourquoi lorsque vous créez une rubrique, vous devez savoir quel type de rubrique vous devez sélectionner, selon le type de contenu que vous devez ajouter. Si vous réalisez, après avoir créé une rubrique et commencé votre saisie, que votre contenu ne correspond pas au type désigné vous devrez la supprimer et en créer une nouvelle.
Titres des rubriques
Dans le cas d’objets de rubrique, la propriété Title est liée, mais distincte du titre qui s’affichera dans la sortie publiée. Le titre publié provient de l’élément de titre du contenu de la rubrique, et non de la valeur de la propriété. Lorsque vous créez une nouvelle rubrique pour la première fois, la propriété Title que vous saisissez est utilisée comme titre dans le contenu de la rubrique; cependant, ces deux éléments ne seront à partir de ce moment-là plus connectés. La propriété Title et le titre de la rubrique peuvent être différents. La déconnexion permet une gestion plus efficace des rubriques du Repository.