Versions Compared

Key

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

Process General Details


Process NameUI 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 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



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.

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, Design wireframes for the user 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, Key-value pair of additional UI text in the translation management tool
Role(s) InvolvedDoc team member
Stage ActivitiesDoc team member incorporates review comments 


Exceptions 

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

No Exceptions

Process Metrics

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

No process metrics