Just a heads up: On March 24, 2025, starting at 4:30pm CDT / 19:30 UTC, the site will be undergoing scheduled maintenance for a few hours. During this time, the site might be unavailable for a short while. Thanks for your patience.

×
Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in

Whats the best practice for documentation in Jira and Confluence?

Markus
Contributor
March 9, 2020

I have seen many different approaches for documentation in Jira and Confluence and was wondering what the official recommendation is?

 

Things i've seen:

  • Document everything related to a User Story within the User Story (Confluence is for Epic and above Documentation)
  • Add only the most important documentation to the User Story, create the detailed documentation for each user Story inside of Confluence (so each US = one page)
  • and the classic: "Dont document anything cause we are agil"...

1 answer

1 vote
Alex Koxaras _Relational_
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
September 25, 2021

Hi @Markus 

I dont think that there is such thing as an official documentation on best practices. There is however this article from Atlassian, in which you will see basic things. And another article here. Organizing information and content is part of Information Architecture, for which many books have been written. After a quick google search you can read a small guide here. But feel free to search for your own.

However about the last bullet "and the classic: "Dont document anything cause we are agile", this is completely wrong since the Agile manifesto states:

Individuals and interactions over processes and tools
Working software over comprehensive documentation
Customer collaboration over contract negotiation
Responding to change over following a plan

That is, while there is value in the items on
the right, we value the items on the left more.

 So this doesn't mean that if you are Agile, you don't document things. You do. But you give your priority in working software.

Suggest an answer

Log in or Sign up to answer