Generate Documentation

Colectica can generate documentation for any item. Your documentation can be saved in PDF, HTML, or Rich Text format.

  1. To generate documentation for an item, click the Generate Documentation button on the ribbon.

    ../../../_images/generate-documentation-button1.png
  2. After clicking the Generate Documentation button, the Generate Documentation dialog will appear. This dialog lets you set some options for your documentation.

    ../../../_images/generate-documentation-options-general.png
  3. On the Formats tab, choose the formats to generate.

  4. After choosing your settings, click the Generate button. Colectica will create your documentation.

Generate Documentation to Comply with Adobe Acrobat Accessibility Checks

To create documentation that passes Adobe Acrobat accessibility checks, follow these steps.

  1. In the Generate Documentation dialog, ensure the Accessibility mode checkbox is checked.

    When the Accessibility mode checkbox is checked, the following changes are made.

    • Additional headers are included above tables

    • Headers are not shaded

    • Images are not included in headers to represent the item type

  2. Choose the HTML output format for the documentation.

  3. Open the generated HTML documentation in Microsoft Word.

  4. In Word, export the document to PDF (File - Export - Create PDF/XPS).

  5. Check the accessibility report in Adobe Acrobat to confirm there are no issues.