how do you document your projects?

Deleted user March 11, 2023

I have noticed that in general on this community there are no effective or recent articles and discussions on how to document a project using Jira and using Confluence.

I would like to start a useful discussion on whether one can really manage the documentation of a project in a practical and time-saving way.

We know that many of us here use Confluence to get started, use its powerful page templates, and can put up with certain useless macros (like the emoji one) while waiting for some Atlassian product owner to understand that we need something else to be effective.

Well... After I've created the documents, I need to create maybe one or more epics and that's when the hard way begins.

You have to create the issue from the page by selecting the text and then the interface to compose the issue is really mean, small, not very customisable. And here you have to buy the first plugin ...

Or you have to go to Jira, change the web page, leave Confluence and you have to create the Jira project, the stories, the versions, etc.

But from the issues then you have to link to Confluence by copying and pasting the URL ... stuff that was maybe only done in 1999 not today in 2023.

Is it possible that there is not a way to write Confluence pages from within issues or create issues from within Confluence pages in a more organised way?

How do you do it?

As food for thought, I suggest you read this two articles, which also roughly represents the way I write project documents:

https://medium.com/@vijmoorthy/modelling-and-documenting-the-software-architecture-4a1a46ab0cd0 

https://medium.com/@altexsoft/technical-documentation-in-software-development-types-best-practices-and-tools-27d628d1369b 

 

1 answer

0 votes
Vronik
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
April 11, 2024

Hello
I find your documents very interesting, I'm saving them and thank you for sharing

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events