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 Sign up to answer
Atlassian Community Anniversary

Happy Anniversary, Atlassian Community!

This community is celebrating its one-year anniversary and Atlassian co-founder Mike Cannon-Brookes has all the feels.

Read more
Community showcase
Julia Dillon
Posted Tuesday in Jira

Tell us how your team runs on Jira!

Hey Atlassian Community! Today we are launching a bunch of customer stories about the amazing work teams, like Dropbox and Twilio, are doing with Jira. You can check out the stories here. The thi...

159 views 1 17
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