Skip to end of metadata
Go to start of metadata

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

Compare with Current View Page History

Version 1 Next »

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 NameUser Assistance Process 
Process Description

User Assistance Process involves creating text for the user interface of the various products of Ekstep Foundation.

User Interface text involves various types of texts namely:

  • Labels
  • Buttons
  • Prompt text
  • Alt text
  • Messages (error messages, pop-ups, information messages etc)
  • Inline text
Process Scope

The user assistance process involves creating/updating UI text for all stories and enhancements of any given release

Process RolesDoc team member, design team member, PM, tech manager
Process BoundaryAny new or updated design triggers a requirement for UI text.
Process Stages

UI text creation/updation process involves the following stages:

  • User story walkthrough with design and PM
  • Doc team creates/update the text
  • Review and rework
  • Final text shared with the engineering team to incorporate in the code

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.

User Story Walkthrough

InputPRD of the Epic
OutputAction items on Doc team and Design team
Role(s) InvolvedPM, Doc team member, design team member
Stage ActivitiesUnderstand the user story(happy and unhappy flow)

Create/Update UI Text

InputUser story
OutputUI text
Role(s) InvolvedDoc team member
Stage ActivitiesUnderstand the user story and provide appropriate text

Review and Rework

InputUI text
OutputReview comments
Role(s) InvolvedDoc team member, PM, Design member
Stage ActivitiesReview the text provided and give inputs

Final Output

InputReview comments
OutputThe final set of UI text
Role(s) InvolvedDoc team member
Stage ActivitiesDoc team member incorporates review comments 

Exceptions 

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

Process Metrics

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

  • No labels