Workflow/Transition Documentation
- Adam Labus
General information
Available since v. 1.48.*
How many times do you need to check all workflow transitions and see how they work and what functions are used?. Workflow documentation allows you to generate complete workflow documentation including all information such as diagram, statuses, transitions, all functions (Conditions, Validators, Post Functions), screens, properties (for statuses and transitions), etc.
… and you can do it with just one click in Jira
Where you can generate Workflow documentation
On the Workflows page
1) Click the small doc icon in the Actions column to generate documentation, for a Workflow (for Active workflows, a live version will be generated)
or
2) Click Generate documentation and choose the workflow for which you want to generate documentation (includes drafts)
On the Workflow Text page
Click Documentation on the Workflow Text page (documentation will be generated for the current workflow you are viewing, live or draft)
On the Project Documentation page
In the Workflows section of the Project Documentation page, click the small doc icon.
On the project settings page
In the Workflows section of the project settings page, click the small doc icon.
Where you can generate Transition documentation
On the Workflow Text or Diagram page
Click the Documentation icon on the Workflow Text or Diagram page (documentation will be generated for the selected workflow transition)
Direct link documentation
Open a 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 the documentation view
You can change the documentation view by adding parameters to the URL, such as
&collapse={COLLAPSE_ITEMS} to hide certain elements where {COLLAPSE_ITEMS} - tocSubMenu, transitionDetails or screenDetails
Since version 1.53.*, you can configure this directly in the GUI by clicking the icon in the top right corner, where you can choose additional configuration items.
Additionally, you can save a new view as default for any documentation.
But … also since version 1.53.* a new parameter, transition (transition id or name) allows you to see only the documentation for that 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 full configuration details
When the Share Workflow Documentation option in Extensions Configuration
{JIRA_URL}/secure/ExtenderExtensions.jspa
is enabled, all users with project administration rights will see the documentation icons in the project settings (Workflows section) and they will be able to view the full worflow documentation.
Export documentation as a file (PDF/JPG/PNG)
You have several options to export the documentation, as a single PDF file (Print as a PDF file) or as multiple files, with each piece of important data (e.g., transitions, diagrams) exported separately
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 the documentation view
Available since v. 2.0.0
Export documentation as a 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)
Available since v. 3.15.0
New look of the "Documentation view"