Steta Publishers
  • Home
  • About
  • Work
  • Twitbits
  • Blog
Steta Publishers was a writing and brand language consultancy that ran from 2012 to 2016. We are no longer available for projects. Our founders now work here and here. 

Reviewing a Software Product for Language 

16/7/2013

0 Comments

 
In one of my earlier posts, I pointed out how as technical writers, we contribute to the product development process.  One of the important ways in which we make this contribution is to make common sense of the application by reviewing onscreen language. Mind you, we do these reviews as a feature is being developed by the technical groups – not after. I say we make common sense of the application because you will be amazed (read shocked) at the way products are developed and released to market. 

The following check list will help you when you do a language review of a product.
  • Is the language consistent in tone and style with the rest of the product?
  • Is the text grammatically correct? 
  • Is the punctuation right? 
  • Is the text as concise and meaningful as can be?
  • Is the casing in the text consistent?
  • Do all screen elements (headings, sub headings, instruction text, check box options, labels) follow standard user interface guidelines?
  • Can the user complete the task on the screen intuitively? Does he or she need any help? If yes, what assistance can you offer? Is this assistance easily discoverable? That is, does the user know where to look for help?
  • Does the workflow of the task (clicks to complete a task) make for a sensible flow? 
  • Are there confirmation messages to tell the user that he or she has completed a particular task?
  • Are there warning messages that alert the user about possible results of actions that he or she is about to take? If there are any actions that the user should NOT do, is that clearly called out?
  • Are the error messages helpful? That is, do the error messages give a recommendation to the user as to the next course of action (instead of leaving him or her at a dead end)?

If your product is being translated into different languages, add these translation considerations to your check list – this will help reduce translation costs.
  • Use simple sentences. 
  • Use words that are familiar.
  • Use the same word across the interface instead of using synonyms. 
  • Use the same clause wherever possible. 
  • Do not use jargon or slang.
  • Do not use one word to mean different things.
  • Do not use idioms.

Beyond these language-related checks, remember that as a technical writer, you are contributing to the User Experience (Ux) of the product. In this capacity, you can do some basic checks of the user interface.
  • Are all the design elements consistent with the rest of the product?
  • Is the spacing of the design elements appropriate?
  • Is the design and layout of the page pleasing and professional?
  • Is the text aligned properly?

I am sure you will feel empowered with these check lists that are by no means exhaustive. Go ahead and make a difference, dear technical writer!  

Urmilla Chandran
The author is co-founder and Director, Content Development at Steta

0 Comments



Leave a Reply.

    Authors

    Steta's founders, Urmilla Chandran and Armeen Kapadia author this blog. 

    We love letting our thoughts (crazy, stupid or smart) out for some fresh air.


    Archives

    October 2016
    May 2016
    March 2016
    January 2016
    October 2015
    September 2015
    June 2015
    May 2015
    December 2014
    November 2014
    October 2014
    September 2014
    July 2014
    March 2014
    January 2014
    December 2013
    November 2013
    October 2013
    September 2013
    August 2013
    July 2013
    June 2013
    May 2013
    April 2013
    March 2013
    February 2013
    January 2013
    December 2012
    November 2012
    October 2012
    September 2012
    August 2012
    July 2012
    June 2012


    Categories

    All
    Awards
    Blogging
    Books
    Bookstore
    Business Writing
    Classical
    Content
    Corporate
    Culture
    Design
    Dictionary
    Editing
    Grammar
    Help Authoring Tools
    Image
    Language
    Life
    Literature
    Media
    News
    Newspaper
    Personal
    Press
    Printing
    Problem
    Professional
    Punctuation
    Reading
    Retrospective
    Review
    Solution
    Story
    Technical Writing
    Technology
    Thesaurus
    Tools
    Typewriter
    Vocabulary
    Writers
    Writing


Home

Work
Blog
About


Copyright © Steta Publishers 2012–16. All rights reserved.