Générer des fichiers à partir d'un Modèle d'aide

Une fois que vous avez créé un modèle de documentation à l'aide des outils de création d'aide disponibles dans Enterprise Architect , l'étape suivante consiste à générer la documentation à partir du modèle. Enterprise Architect supporte la génération de pages Web HTML et de fichiers PDF à partir du même modèle.

Dans les deux cas, le formatage et disposition sont contrôlés par des feuilles de style et gabarits , qui peuvent être personnalisés pour répondre à vos besoins spécifiques.

Les rubriques d'aide Génération de fichiers HTML et Génération de fichiers PDF décrivent les étapes nécessaires à la génération des ensembles de fichiers respectifs, ainsi que les détails sur les gabarits et les feuilles de style utilisés et sur la manière de les modifier.

Au cours du processus de création de l'aide et une fois terminé, il est important de générer le contenu sur lequel vous travaillez au format HTML et/ou PDF. Cela vous permet de visualiser l'apparence de votre contenu pour le consommateur final et de vérifier les erreurs de formatage évidentes, les omissions et autres erreurs. Il est préférable de générer les deux formats car il y aura des différences subtiles entre les deux sorties.

Un bon document PDF doit être facile à lire, bien structuré et avoir une apparence et une sensation cohérentes. Assurez-vous que l'espacement des paragraphes, le placement des images, le placement des titres et les autres problèmes de formatage sont vérifiés et corrigés si nécessaire. La même approche doit être utilisée pour le HTML, avec la nécessité supplémentaire de vérifier les hyperliens et autres constructions réservées au Web.