Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info
iconfalse
titleHow 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

Note

All information in this section is mandatory.


Process NameRelease Documentation Process
Process Description

The release documentation process involves creating and maintaining documents for and on the different the monthly releases of the 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 published on the websites, pdfs, videos)
  • Developer Documents
Process Scope

The Release Documentation process identifies the stories Jira stories and enhancements being worked on and delivered for a particular release and documents the same. 

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 6 stages: 

  1. Requirement analysis (analysis of Jira stories for each release)
  2. Creating documentation tickets/documentation dashboard
  3. Assigning the ticket to a documentation team member
  4. Completion of the assigned ticket by doc team member
  5. Review and review incorporation
  6. Publishing the document


Process Diagram

Note

This section is optional. However, creating a visual representation for your process helps recall and compliance.

Refer to the sample templates here .


Info

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 (within the team)
Stage ActivitiesAnalyse the items scoped for the release and plan documentation tasks


Documentation Dashboard

InputDocumentation tasks planned for the release
OutputDocumentation dashboard on Jira
Role(s) InvolvedDoc Release Manager (within the team)
Stage ActivitiesCreate a dashboard with planned documentation tasks a


Assign Tasks

InputDocumentation Dashboard
OutputAssignees against each task
Role(s) InvolvedDoc Release Manager (within the team), doc team members
Stage ActivitiesAssign each task to a doc team member


Task Completion

InputList of tasks assigned
OutputPRs (if documentation is for the website), video, pdfs etc (in case of a standalone document)
Role(s) InvolvedDoc team members, PMs, Tech Managers (In case of queries)
Stage ActivitiesDoc member works on the tasks assigned


Review and Rework

InputPRs or documents in other formats
OutputReview comments 
Role(s) InvolvedDoc team members, PMs, Tech Managers (if technical reviews are required)
Stage ActivitiesThe artefacts are reviewed and suggestions given 


Publish

InputReviewed PRs or other artefacts
OutputFinal doc output
Role(s) InvolvedDoc team members
Stage ActivitiesDoc member reworks and resends the document 


Exceptions 

Note

This section is mandatory. If there are no exceptions to the process, mention it as such.

No Exceptions

Process Metrics

Note

This section is mandatory. If the process does not have any metrics, mention it as such.