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 votes

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 Sign up to answer
Community showcase
Posted Sep 18, 2018 in Jira

What modern development practices are at the heart of how your team delivers software?

Hey Community mates! Claire here from the Software Product Marketing team. We all know software development changes rapidly, and it's often tough to keep up. But from our research, we've found the h...

23,955 views 2 7
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