Conception des sujets dans la documentation

Dans la documentation GLPI qui utilise DITA un sujet se nomme un topic. Un topic (sujet) peut être découpé en plusieurs sous-topics .

Exemple : "Gérer l'inventaire" > gérer les ordinateurs > composants ordinateur

Pour chaque sujet (topic) :

  • On rédige un topic avec une description brève et une description détaillée (si présente et si nécessaire)
  • Des actions en mode pas à pas. Un topic de type task par action (Créer, voir , éditer, effacer, associer à etc....)

Exemple :

  • Topic "Gerer les ordinateurs"
  • Sous topic type task " Créer un ordinateur"
  • Sous topic type task " Voir un ordinateur"
  • Sous topic type task " Créer un ordinateur"

Voir les fichiers sources de la documentation pour observer la forme des fichiers correspondants.

DITA permet d'écrire dans un même fichier des informations qui concernent des audiences différentes débutants/experts par exemple.

Pour distinguer les informations, il suffit tagger l'information pour "experts" par avec le terme "Advanced".

<p audience="advanced" > information avancé blalblalblalblalblalblallblal</p> 

Le paragraphe ci-dessus sera visible ou pas en fonction de la politique de génération de la documentation (cible "tous", ou seulement "débutants" ou seulement "experts").