UI Writing Process

Process General Details



Process Name

UI Writing Process 

Process Description

UI Writing process involves creating text for the user interface of various Sunbird capabilities. It ends with creating the key-value pair for the associated UI text in the required translation management tool.  

User Interface text involves various  categories of texts as seen on the user's interface each with its own set of guidelines, 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





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 

No Exceptions

Process Metrics

No process metrics