Structure des fichiers et des dossiers

Lorsque vous travaillez sur un fichier, vous devez créer une structure de dossiers qui permette aux auteurs de repérer facilement les rubriques à modifier ou à utiliser comme références croisées.

La structure de fichier idéale pour un projet DITA consiste à conserver les cartes DITA à la racine du dossier référentiel de documentation, et les rubriques dans des sous-dossiers à la racine. Cette structure garantit que les liens topicref renvoyant vers du contenu se déplacent toujours vers le bas de l'arborescence. Puisque les cartes DITA forment un super ensemble d'informations composé de rubriques, enregistrer les cartes DITA dans un super dossier constitue une approche logique.

Les images et les autres ressources médias doivent être enregistrées dans un dossier séparé (par exemple, /images).

Vous pouvez utiliser un certain nombre de topologies de fichier, notamment :

• selon le type d'information (par exemple : les informations de type concept, task et reference) ;
• selon le sujet du système documenté (par exemple : moteur, système de carburant) ;
• selon le domaine (par exemple : démarrage, comptabilité).

L'utilisation d'un emplacement de stockage logique et sans contexte pour enregistrer les rubriques réduit les problèmes pouvant être dus au déplacement des fichiers d'un dossier de projet à un autre. Cela permet également de trouver les fichiers plus facilement.

Ne définissez jamais les emplacements de stockage là où vous souhaitez générer les fichiers de sortie, car cela introduit du contexte dans les emplacements des fichiers et rompt le principe fondamental de séparation de contenu à partir du format de livraison.

Évitez d'utiliser une structure de fichiers plate ou peu profonde, avec des centaines de fichiers de rubriques enregistrés dans un seul dossier. Cette structure peut ralentir la récupération des fichiers dans les éditeurs DITA, où la boîte de dialogue Fichier > Ouvrir, par exemple, doit lister tous les fichiers sélectionnables.