Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
4,364,283
Community Members
 
Community Events
168
Community Groups

Automating documentation tasks and creating a public Change Log

 

Currently our company has a very manual process for release notes and they’re just created on-demand for certain customers and issues that were relevant to them. We don't have formal sprints or release versions and are constantly updating our product and would like to be able to automatically capture these updates in a Change Log that customers can visit online or subscribe to.

 

Here is my brainstorm for this, keeping in mind that we are migrating to continuous integration / continuous deployment at some stage (CI/CD) 



  1. All ENG tickets need documentation where the experience for users will be affected (Should we create a checkbox/flag for this)?
  2. When closing ENG ticket where the experience for users will be affected, developer fills out ‘developer notes’ field
  3. Once developer notes are filled that triggers DOC tasks:
    1. Populate release notes fields - Public Summary and Public Description
    2. Create Knowledge Base article
    3. Create blog post and potentially a newsletter or EDM
  4. Release to PROD should not be allowed until:
    1. QA is complete
    2. DOC tasks are finished
  5. Information that is populated in the Public Summary and Public Description field should be made available via a Change Log page on our website or Help Centre.



I would love to hear how this is possible with Jira and how others have implemented this.

 

Thanks!

Theresa

0 comments

Comment

Log in or Sign up to comment