Creating a How To help guide for Project Users

I create a Project to use Jira for Requirements and defects.  I want to create a How To Guide for all Project users. I am thinking to create a Dashboard with a Gadget list all How To tasks and the due process. I was not able yet to find the right gadget. I appreciate any suggestions for suitable gadget or another approach. Thank you

1 answer

0 vote

There is an "introduction" gadget available as standard. 

There's also a "text box" gadget that is a bit more free-format, but it is disabled by default, as it can be used to open security holes.  An admin can enable that in the "manage plugins" section if you're willing to risk that.

Generally though, JIRA is not a documentation system - you might find it better to provide links to proper documentation.  Most "introduction" gadgets I see are a very brief introduction (2-5 lines of text) with links to detialed pages in documentation.

If the gadgets don't work for you and you want the users to see a list of links from the project you can also add links in the project directly.  When you go to the project page, on the left you'll see a Projects shortcuts section and a + sign:

Screen Shot 2017-06-15 at 10.57.28 AM.png

You can add links that you think the team may find relevant here as well!

Cheers,

Branden

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 ...

3,327 views 14 20
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