Generating Files from a Help Model

Once you have created a documentation model using the Help Authoring tools available in Enterprise Architect, the next step is to generate documentation from the model.  Enterprise Architect supports generation of both HTML web pages and PDF files, from the same model. 

In both cases the formatting and layout is controlled by stylesheets and templates, which can be customized to suit your specific requirements.

The Help topics Generating HTML Files and Generating PDF Files, set out the steps required to generate the respective file sets, as well as providing details about the templates and stylesheets that are used and how to modify them.

During the Help Authoring process and upon completion it is important to generate the content you are working on into HTML and/or PDF form. This allows you to view how your material will appear to the final consumer, and to check for obvious formatting errors, omissions and other mistakes. It is best to generate both formats as there will be subtle differences between the two outputs.

A good PDF document will be easy to read, well formed and of a consistent look and feel. Ensure paragraph spacing, image placement, heading placement and other formatting issues are checked and corrected if necessary. The same approach should be used for HTML with the additional necessity of checking hyperlinks and other web-only constructs.