Best way to model/ catch documentation needs

Jerry O'Sullivan March 23, 2024

Hi

We are building a SAAS product and we are creating user documentation in parallel. Our team of writers have their own JIRA project. I am looking for some options on how best to get developers to flag tickets they are working on that need documentation updates

Some options

1  A Mandatory fields before a ticket goes in progress asking if docs are needed... This might be a pain as not all tickets need doc updates

2 A new optional state that developers can put tickets into 

3 A new optional field that developers that tag a ticket for a document update

All these can be trigger points for a new tickets to be created in the documentation project

 

Any other ideas?

 

Thanks

J

2 answers

1 vote
John Funk
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
March 23, 2024

Hi Jerry,

All of those would work. Have you asked the developers what they would prefer to do to trigger the need?

0 votes
Stephen Wright _Elabor8_
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
March 23, 2024

Hi @Jerry O_Sullivan 

Could you flag the issues upfront, and have this auto-notify or auto-create issues for the Writers?

You could use Automation - for example...

  • When a developer's ticket reaches status A
  • If the field "Docs Needed?" is checked
  • Then...
    • Create a ticket in the Writer's Project, and...
    • Link the two tickets together, and...
    • Notify the Writer via email

Ste

Suggest an answer

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

Atlassian Community Events