Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 7 Next »

Process General Details

All information in this section is mandatory.

Process NameRelease 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:

  • Release Notes
  • End-user documents (How-To Documents published on the websites, pdfs, videos)
  • Developer Documents
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 RolesProduct Manager, Tech Manager, Implementation Team, Documentation Team
Process BoundaryThe 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

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

InputFinal scoped items for the release
OutputDocumentation dashboard for the release
Role(s) InvolvedDoc Release Manager 
Stage ActivitiesAnalyse the items scoped for the release and plan documentation tasks

Planning and Estimation

InputDocumentation dashboard for the release
OutputTime and assignee set against each task in the created dashboard
Role(s) InvolvedDoc Release Manager 
Stage ActivitiesDoc release manager assigns each ticket to the doc team members

Document Creation

InputList of tasks assigned
OutputFirst draft for review
Role(s) InvolvedDoc team members, PMs, Tech Managers 
Stage ActivitiesDoc member works on the tasks assigned. In case of queries, has conversations with relevant PMs or Tech Managers.

Review and Rework

InputDraft of the task assigned
OutputReworked draft
Role(s) InvolvedDoc team members, PMs, Tech Managers
Stage ActivitiesThe 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

InputReworked drafts
OutputFinal doc output
Role(s) InvolvedDoc team members
Stage ActivitiesDoc 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.

The process does not have any metrics as on date.

  • No labels