To be able to capture all user documentation requirements, it is crucial that we create Jira tickets under the development epic. Currently, each epic has a mandatory field for documentation. Teams must answer yes or no to this field.
Process:
- If you need user documentation, in the epic Jira ticket, click Yes in the Documentation Required? field.
- During epic grooming/planning with their product owner, if available, the team lead/scrum master creates a Jira ticket in the DOC project to capture what exactly we need to add to the documentation.
- From the point of view of the J1 user, explain what has been added, changed, or deleted from the J1 app, integration, or API.
- Provide the context and benefit to the user for the change by linking the dev tickets and references to any RFCs.
- Add the SME who can provide further information and technical validation.
- The DOC ticket is added to the DOC project backlog, which is prioritized by the product manager.
- The technical writer grooms and plans the backlog with the product manager according to when new features are released.
- The technical writer drafts the documentation with the assistance of any base text provided by the developer, SME, and any other contributors.
- The technical writer creates a PR and requests approval from the SME, PM, and any other contributors.
- Upon approval, the technical writer merges the PR, and initiates the process of publication.