Tool for a workflow manual

Question

I am looking for a tool to easily build workflow manuals where all the information concerning one workflow are put togheter. It should not only content status and transitions with small descriptions but full descriptions of a workflow, including input/output, flowcharts with process symbols, descriptions of every status including checklists if needed and links to basic documents that are needed in the given workflow.

Is there such a tool in Jira?

Walter Buggenhout · Accepted Answer

In a way, Jira IS your tool. The better you configure your workflow with the right screens, conditions, validators and so on, the less your need for additional documentation will become.

But aside from that, I get your point. If you need a tool for documentation that works nicely together with Jira, integrates well, then have you taken a look at Confluence?

Alana Fernando · Accepted Answer

hi @Dominique Quadroni,

to the best of my knowladge there is no such feature in default JIRA. I found a plugin that might do the trick for you Gliffy Diagrams, Workflow Analyzer for Jira

If that doesn't fit find a solution partner and get your feature developed.

Wouter Bruinings · Accepted Answer

We use draw.io in Confluence. We paste a screenshot in draw.io and clarify it using text and process symbols in the figure. Then we further explain the use of a workflow in a table below the figure.

Jack Brickey · Accepted Answer

I use Confluence for documentation and I often have a need to pull in a workflow. I also use draw.io to recreate the workflow. The unfortunate thing is that there is no macro in Confluence to import the actual workflow so the drawing, as with any documentation can become out of date. It would be great to have such a macro that would maintain a current view of the workflow along with all validations, post functions, screens, etc.