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	UI Writing Process
Process Description	UI Writing Process involves creating text for the user interface of various Sunbird capabilities. User Interface text involves various types of texts namely: Page & section titles Labels Buttons Prompt text Alt text Messages error messages, confirmation messages, failure messages, success messages, warnings, pop-ups, information messages Inline text Navigation bar Radio buttons & Checkboxes Breadcrumbs
Process Scope	The user assistance process involves creating/updating UI text for all stories and enhancements of any given release
Process Roles	Doc team member, design team member, PM, tech manager
Process Boundary	Any 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 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

Input	PRD of the Epic
Output	Action items on Doc team and Design team
Role(s) Involved	PM, Doc team member, design team member
Stage Activities	Understand the user story(happy and unhappy flow)

Create/Update UI Text

Input	User story, Design wireframes for the user story
Output	UI text
Role(s) Involved	Doc team member
Stage Activities	Understand the user story and provide appropriate text

Review and Rework

Input	UI text
Output	Review comments
Role(s) Involved	Doc team member, PM, Design member
Stage Activities	Review the text provided and give inputs

Final Output

Input	Review comments
Output	The final set of UI text, Key-value pair of additional UI text in the translation management tool
Role(s) Involved	Doc team member
Stage Activities	Doc 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.

UI Writing Process