Process General Details
All information in this section is mandatory.
| Process Name | Release Documentation Process |
|---|---|
| Process Description | The release documentation process involves creating, maintaining and publishing documentation for external user consumption, for every version of the solution released to the client. Documentation delivery is part of the solution delivery. It follows the same delivery cadence. Documentation deliverables are defined by the scope of the release. Documentation for release delivery typically entails creating and publishing the following artefacts:
|
| Process Scope | The Release Documentation process identifies the Jira stories and enhancements being worked on and delivered for a particular release and documents the same. |
| Process Roles | Product Manager, Tech Manager, Implementation Team, Documentation Team |
| Process Boundary | The release documentation cycle begins with each release cycle and ends when the release is pushed to production (live) |
| Process Stages | Release Documentation has 6 stages: 1) Requirement analysis 2) Planning and estimation 3) Document creation 4) Review & Rework 5) Publish |
Process Diagram
This section is optional. However, creating a visual representation for your process helps recall and compliance.
Refer to the sample templates here .
This section is mandatory. Repeat this section as many times as required from stage 1 of the process until the last stage of the process. Delete the Information section after you enter details in the table.
Requirement Analysis
| Input | Final scoped items for the release |
|---|---|
| Output | Documentation dashboard for the release |
| Role(s) Involved | Doc Release Manager (within the team) |
| Stage Activities | Analyse the items scoped for the release and plan documentation tasks |
Planning and Estimation
| Input | Documentation dashboard for the release |
|---|---|
| Output | Time and assignee set against each task in the created dashboard |
| Role(s) Involved | Doc Release Manager (within the team) |
| Stage Activities | Doc release manager assigns each ticket to one or more of the doc team members |
Document Creation
| Input | List of tasks assigned |
|---|---|
| Output | First draft for review |
| Role(s) Involved | Doc team members, PMs, Tech Managers (In case of queries) |
| Stage Activities | Doc member works on the tasks assigned |
Review and Rework
| Input | Draft of the task assigned |
|---|---|
| Output | Reworked draft |
| Role(s) Involved | Doc team members, PMs, Tech Managers (if technical reviews are required) |
| Stage Activities | The draft is reviewed and sent back to the creator to incorporate review comments |
Publish
| Input | Reworked drafts |
|---|---|
| Output | Final doc output |
| Role(s) Involved | Doc team members |
| Stage Activities | Doc release manager approves and publishes the document |
Exceptions
This section is mandatory. If there are no exceptions to the process, mention it as such.
No Exceptions
Process Metrics
This section is mandatory. If the process does not have any metrics, mention it as such.
Add Comment