Workflow - ideal place for "update documentation" task

This is a question about ideal working practice, and workflows.

We have 1,500 of documentation (more reference, not "how to") for our mature appication, which we are updating all the time. It is an internal application used only by our users, about 250 people. We want to try to keep it updated in line with small and large changes.

We are considering having a parallel task or activity on the workflow to update the documentation.

For sure, we will not delay the release if the documentation is incomplete.

We were wonding where people are putting the task or activity on the workflow. Before testing, after testing but before release, etc.

If you have any practical advice, or can refer me to a suitable link, I would be very grateful.

Thanks, Shireen

1 answer

I would actually have a have a separate documentation workflow from your development workflow since there are many times when documentation can be updated without any relationship to the development workflow such as adding videos, pictures, fixing typos, etc.

You can use links (related to) to show the relationships between the documentation and the development issues in both directions.

Suggest an answer

Log in or Join to answer
Community showcase
Sarah Schuster
Posted Jan 29, 2018 in Jira

What are common themes you've seen across successful & failed Jira Software implementations?

Hey everyone! My name is Sarah Schuster, and I'm a Customer Success Manager in Atlassian specializing in Jira Software Cloud. Over the next few weeks I will be posting discussion topics (8 total) to ...

2,916 views 12 18
Join discussion

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you
Atlassian Team Tour

Join us on the Team Tour

We're bringing product updates and pro tips on teamwork to ten cities around the world.

Save your spot