Workflow/Transition Documentation

General information

Available since v. 1.48.*

How many times do you need to check all workflow transitions and see how it works and what functions are used?. Workflow documentation gives you ability to generate full workflow documentation with all informations like diagram, statuses, transitions, all functions (Conditions, Validators, Post Functions), screens, properties (for statuses and transitions), etc.

… and you can do it with one click in Jira

 

Where you can generate Workflow documentation

On the Workflows page

1) Click small doc icon in Actions column to generate documentation do Workflow (for Active will be generated live version)

or

2) Click Generate documentation and choose for which workflow you want to generate documentation (contains drafts)

On the Workflow Text page

Click Documentation on Workflow Text page (documentation will be generated for the current workflow you are viewing (live or draft)

On the Project Documentation page

On the Project Documentation page in Workflows section click small doc icon

 

On the project settings page

On the project settings page in Workflows click small doc icon

 


Where you can generate Transition documentation

On Workflow Text or Diagram page

Click Documentation icon on Workflow Text or Diagram page (documentation will be generated for the selected workflow transition)

 


Open new browser tab and paste url

{JIRA_URL}/secure/ExtenderWorkflowDocumentation.jspa?workflowName={WORKFLOW_NAME}&mode={WORKFLOW_MODE}where:

{JIRA_URL} - your Jira url address

{WORKFLOW_NAME} - Worfkflow name

{WORKFLOW_MODE} - Workflow mode, “draft” or “live”

 

Change documentation view

You could change the documentation view by adding parameters to the url like

&collapse={COLLAPSE_ITEMS} to hide some elements where {COLLAPSE_ITEMS} - tocSubMenu, transitionDetails or screenDetails

Since version 1.53.* you can do this using the configuration from the GUI (just click the icon in the top right corner) where you have an additional choice regarding some configuration items.

Additionally, you can save a new view as default for any documentation.

 

But … also since version 1.53.* there is a new parameter called transition (transition id or name) that allows you to see only the documentation for that particular transition, example:

  • {JIRA_URL}/secure/ExtenderWorkflowDocumentation.jspa?workflowName=test&transition=1

  • {JIRA_URL}/secure/ExtenderWorkflowDocumentation.jspa?workflowName=test&transition=Create

 


Share documentation with project administrators

Before making this option available, check if users should see the details of this full configuration

When option Share Workflow documentation in Extensions Configuration

{JIRA_URL}/secure/ExtenderExtensions.jspa

is enabled, all users who have the right to administer the project will see the documentation icons in the project settings (Workflows section) and will have the right to view the full documentation of the workflows.

 


Export documentation as file (PDF/JPG/PNG)

You have several options to export the documentation, of one PDF file (Print as PDF file) or as many files (each important data is exported separately, e.g. transition, diagram, etc.)

Example - one PDF File:

Example - several PDF Files

Example - several JPG Files

 

Availability

Available since v. 1.49.0

  • Share documentation with project administrators

Available since v. 1.53.0

  • Change documentation view

Available since v. 2.0.0

  • Export documentation as file (PDF/JPG/PNG)

Available since v. 2.10.0

  • Workflow Transition on Diagram/Text Workflow view

Available since v. 3.2.0

  • Workflow screens summary

  • Full support for Triggers (Jira Software)

Available since v. 3.10.0

  • Share Workflow documentation - when enabled, project administrators can view workflow documentation in the project settings (Workflows section)