Aller au contenu principal

Guide de style DITA - Bonnes pratiques pour les rédacteurs Bonnes pratiques pour les rédacteurs

Introduction
Types d'information et rubriques
Les cartes DITA
Syntaxe et balisage
Langue et ponctuation
Graphiques et images
Références croisées
Réutilisation de contenu
Métadonnées, traitement conditionnel et indexation
Le processus de documentation DITA
Principes de rédaction DITA

Accueil
Syntaxe et balisage
Dates et caractères spéciaux

Syntaxe et balisage
- Organisation des éléments DITA
  Les éléments DITA sont regroupés en différentes catégories pour faciliter l'organisation et la compréhension des informations.
- Utiliser le balisage
- Domaines des éléments
  Dans DITA, pour des raisons techniques et organisationnelles, les éléments sont ordonnés en différents domaines.
- Les descriptions courtes
  L'élément de description courte (ou shortdesc) est sans doute le composant le plus important d'une rubrique DITA et il est également l'un des éléments les plus délicats à rédiger.
- Listes
  Une liste a pour objectif d'aider le lecteur à comprendre les séquences d'informations et les collections contenant des informations similaires. Le type de liste utilisé diffère selon les structures d'informations.
- Paragraphes
  Les paragraphes sont les composants fondamentaux des rubriques. Un élément paragraph (p) doit être une unité autonome qui exprime une idée ou un point généralement en deux phrases liées, voire plus. L'élément p doit être utilisé lorsqu'aucun autre élément sémantique bloc ne convient.
- Procédures et étapes
  L'objectif des documents procéduraux est d'expliquer au lecteur comment accomplir certaines tâches. Grâce à sa structure par étapes, le type d'information "tâche" est spécialement conçu pour les procédures.
- Tableaux
  Un tableau sert à structurer, organiser et présenter des données factuelles qui seront utilisées comme information de recherche ou de référence. Il y a deux types de tableaux génériques dans DITA : table et simpletable.
- Phrases
  La sémantique des mots et des phrases dans un contenu DITA est exprimée à travers une large variété d'éléments phrase.
- Dates et caractères spéciaux
  - Espaces insécables et caractères spéciaux
    Il est possible d'insérer des caractères spéciaux dans un contenu DITA à l'aide des caractères d'échappement Unicode.
  - Dates
    Les dates sont traitées comme du texte, sans signification sémantique particulière.

Dates et caractères spéciaux

Les dates et caractères spéciaux nécessitent un traitement différent du texte normal.

Traduction du DITA Style Guide - Best Practices for Authors (Tony Self) www.ditastyle.com.

Hébergé par IXIASOFT. Généré par <oXygen/> XML WebHelp.