Creating process template documentation

You can add a summary and description to a process template. You can also attach an HTML file archive to a template.

About this task

The summary is displayed to users as they are selecting a template for a new project, and in the Process Description on the Overview tab of any projects created from the template. You can also add a more detailed description to the template.

To add a summary and description to a process template:
  1. Double-click a template in the Process Templates view.
  2. In the editor, add a brief description of the template in the Summary field.
  3. Add details in the Description field and click Save.

A process template can include process documentation in HTML format as a zipped file archive. An example of this is provided in the Scrum Process template. This archive is available from a link in the Process Description on the Overview tab of any projects created from the template.

To add an HTML file archive to a process template:

Procedure

  1. Double-click a template in the Process Templates view.
  2. Click the Links tab.
  3. In the Process Attachments section click Add and add the HTML archive zip file as an attachment. The zip archive must be an attachment named processContent.zip. You can provide translated content in files named processContent_locale.zip. For instance: processContent_en_US.zip. Click OK to close the Add Attachment window.
  4. At the Process Content Path field, enter the path of the index file (or home page) inside the HTML archive. For example, the Scrum process template includes this path: /processContent/ScrumProcessTemplate.htm.
  5. Click Save.

Feedback

Did this help? You can provide feedback at Jazz.net (registration required): Comment in the forums or submit a bug