Navigation Style Guide for Documentation

Kirk Gonzalez April 4, 2024

Hi, I'm using Jira v9.5.1. I've been tasked to write a quick user guide for our department on how our users should use JIRA. I'm trying to find documentation showing the names of the different parts of the Jira interface. Sort of like how the Microsoft Manual of Style explains what to call the various parts of the interface. I don't need anything as elaborate as the MMoS. But for example, when I look at my main screen, I see some text above the title that gives the project name and the issue ID.

Under the title, I see a group of buttons (Edit | Add Comment | Assign | More | To Do)

I also have a left-side menu that has other functions that will take you to a different screen and a right-side section that provides information about the issue. In the middle there are sections like Details, Description, Attachments, etc. And of course there are many different screens that a user will go to.

My question is if there is some documentation where Atlassian describes the terms of the different parts of the interface. I can make my own descriptions, but if possible, I would like to use the correct terms for my little user guide. Can anyone provide a link that calls out the terms for the various interfaces?

1 answer

1 accepted

0 votes
Answer accepted
Aron Gombas _Midori_
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
April 5, 2024

You could find the precise terms in the full user documentation, but because you are looking only for the basics, this "product guide" will show you those: https://www.atlassian.com/software/jira/guides/getting-started/introduction#what-is-jira-software

It is much shorter than the full docs, so it is faster for you to work with IMO.

Kirk Gonzalez April 5, 2024

Thank you, Aron; I will review it. I appreciate the answer and the quick response.

 

Like Aron Gombas _Midori_ likes this

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PRODUCT PLAN
FREE
PERMISSIONS LEVEL
Site Admin
TAGS
AUG Leaders

Atlassian Community Events