Release Documentation Process
- Basreena Basheer
- Sunita Shelar
Process General Details
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 | As part of the Release Documentation process, the team lead identifies the Jira tickets with stories and enhancements being delivered for a particular release. In other words, the team lead identifies the release delivery scope. After the release scope is frozen, the team lead analyzes the relevant stories or tasks and defines the documentation scope for the release. After a careful analysis, tasks are created, effort analysed and work is assigned to the respective team members. Each assignee takes up the task and delivers as per the schedule. After sign-off, the relevant documents are published to the relevant website. The process does not take into account interrupts or scope creeps after the release scope is frozen. |
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 5 stages: 1) Requirement analysis 2) Planning and estimation 3) Document creation 4) Review & Rework 5) Publish |
Process Diagram
Requirement Analysis
Input | Final scoped items for the release |
|---|---|
Output | Documentation dashboard for the release |
Role(s) Involved | Doc Release Manager |
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 |
Stage Activities | Doc release manager assigns each ticket to 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 |
Stage Activities | Doc member works on the tasks assigned. In case of queries, has conversations with relevant PMs or Tech Managers. |
Review and Rework
Input | Draft of the task assigned |
|---|---|
Output | Reworked draft |
Role(s) Involved | Doc team members, PMs, Tech Managers |
Stage Activities | The draft is reviewed for accuracy and completeness by the PM (for product functionality) or the Tech Manager (for technical accuracy) or the doc team member (for a language edit) and sent back to the author 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
No Exceptions
Process Metrics
The process does not have any metrics as on date.