How to use the template

This template is a guide to help you document how you do things to achieve the results you get. In order to get consistent, repeatable outcomes, it is important that others know and understand your method. That is what process documentation is all about.

This template has sections. Each section has prompts with instructions and examples that guide you to specify the information required in each section.

Delete this ' How to use the template' section after writing the information in all the subsequent sections.

Process General Details

All information in this section is mandatory.

Process Name	Release Documentation Process
Process Description	The release documentation process involves creating and maintaining documents for and on the different products of Ekstep Foundation. Documents could be of various types, ranging from pdf to videos. Documentation for the product includes anything from flyers to stand alone documents. Documentation on the product chiefly entails: Release Notes End User Documents (How-To Documents) Developer Documents
Process Scope	The Release Documentation process identifies the 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: Requirement analysis (analysis of Jira stories for each release) Creating documentation tickets/documentation dashboard Assigning the ticket to a documentation team member Completion of the assigned ticket by doc team member Review and review incorporation Publishing the document

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

Documentation Dashboard

Input	Documentation tasks planned for the release
Output	Documentation dashboard on Jira
Role(s) Involved	Doc Release Manager (within the team)
Stage Activities	Create a dashboard with planned documentation tasks a

Assign Tasks

Input	Documentation Dashboard
Output	Assignees against each task
Role(s) Involved	Doc Release Manager (within the team), doc team members
Stage Activities	Assign each task to a doc team member

Task Completion

Input	List of tasks assigned
Output	PRs (if documentation is for the website), video, pdfs etc (in case of a standalone document)
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	PRs or documents in other formats
Output	Review comments
Role(s) Involved	Doc team members, PMs, Tech Managers (if technical reviews are required)
Stage Activities	The artefacts are reviewed and suggestions given

Publish

Input	Reviewed PRs or other artefacts
Output	Final doc output
Role(s) Involved	Doc team members
Stage Activities	Doc member reworks and resends 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.

Release Documentation Process