Pré. | Proc. |
Génération de 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 en supporte la génération de pages Web HTML et de fichiers PDF, à partir du même modèle.
Dans les deux cas, la mise en forme et la disposition sont contrôlées 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éfinissent les étapes requises pour générer les ensembles de fichiers respectifs, ainsi que des détails sur les gabarits et les feuilles de style utilisés et sur la manière de les modifier.
Pendant le processus de création d'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 voir comment votre matériel apparaîtra au 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 sera facile à lire, bien formé et d'une apparence cohérente. Assurez-vous que l'espacement des paragraphes, le placement des images, le placement des titres et les autres problèmes de mise en forme sont vérifiés et corrigés si nécessaire. La même approche doit être utilisée pour HTML avec la nécessité supplémentaire de vérifier les hyperliens et autres constructions Web uniquement.