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. 

Three Things You Wanted to Know about Technical Writing - Part II

27/2/2013

3 Comments

 

Once people begin to accept that technical writing can be a decent career choice, they usually have very similar questions about the field. Here are the top three things that people ask me about technical writing for software applications.

1. What really is technical writing and where does a technical writer fit in?
If you have used a cell phone, camera, fridge, TV, bike, or a car, you have had your brush with technical writing. Yes, all those little booklets with instructions and little diagrams are fine samples of technical writing. These booklets tell you about the device you own – what its features are, how you may use them, what you should do if something malfunctions, and whom to reach out to in case you are unable to troubleshoot on your own.

A technical writer researches and compiles all this information and makes it easier for you (the user), to use the device. If you wish to be a technical writer, you will need to provide similar answers to your audience.

2. Why does the software industry need technical writers?
Software products often tend to be complex in nature – not every user may know how to go about using the product in their first attempt or their tenth attempt even! That’s where a technical writer peeps in to make a difference – by making common sense of an application. 

It follows that a technical writer cannot afford to get caught up in technical jargon and ideas. He or she must understand the working of the product and the audience that is going to use it. With this understanding, the technical writer presents user assistance artifacts.

Though there is a growing awareness of usability aspects, often these are side-stepped in the name of ‘good functionality’. Technical writing is an inherent part of usability. It is a technical writer who can make a difference to ease-of-use of a product with the help of a well-written error message, appropriate instructional text, or with meaningful headers on a screen.

3. What skills do you need to become a good technical writer?
To become a competent technical writer you need to develop a few skills.

a) Review the UI. Contribute to new feature developments by reviewing the UI and questioning the features and the screens that go with it. For this, apart from common sense, you will need good command over English language and basic understanding of User Experience principles.

b) Do your research.  You must review not just the design but also the functionality of the product. Remember, if something does not make sense to you, it probably won’t make sense to the actual user either.

Go through all available formal documentation such as high-level design documents, functional specifications, user experience mock-ups, and test cases to gain an understanding of a feature. But beyond this, talk to product management, developers, QA engineers, and technical support engineers – you never know where you will find those precious ‘gotchas’ or nuggets of wisdom.

c) Test the product thoroughly. Unless you get hands-on experience of the product, you cannot write effective user assistance solutions. In fact, you (as a technical writer), are the first (non-technical) user of the product and must test the product and log bugs. In fact, you must gain such a hold over your subject that you should be in a position to demo the product in front of any audience.

After you've done this kind of serious research you will be able to convincingly write your various user assistance artifacts.

d) Maintain a healthy rapport with all stakeholders. As a technical writer, you are in a unique position to showcase a product to the outside world. Nothing but the best inputs can help you exploit that position. To get the best inputs therefore, it will serve your purposes well if you maintain a cordial relationship with all stakeholders – whether it is the way you conduct yourself at meetings or control the tone of your e-mails.

e) Be aware of the latest trends in your field. In this age of Facebook and Twitter, it will do no good to your image if you are not aware of the latest trends in your field – whether it means staying abreast with the latest trends in user assistance solutions, tools, or guiding principles for usability – you will need to be on your toes.

In my next blog post, I will talk about how technical writing has evolved. Earlier, technical writers used to come into the picture at the end of the product development cycle. Now, you’ll be surprised, we come in at the beginning! 

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

You are a What Writer? - Part I

10/2/2013

0 Comments

 
It must be easy for doctors, engineers, lawyers, teachers, and software engineers to tell people what they do for a profession. People understand without much explanation. That, to my mind, is boring. Try telling people you are a technical writer, and you have a story.   

Some people think that being a technical writer has to do with being technically sound.  They venture, “You must have done some degree in computers then?” or “You write what? Code?” Others are confused – “What do you write about?” or simply, “How much do you write in a day?” Or more direct, “Who reads the stuff you write?”

I’ve seen people’s faces going from ebullient to grim in ten seconds. Still others prefer not to say anything at all – they just nod their heads in an all-knowing manner (while I know perfectly well that they haven’t got the foggiest idea of technical writing). Some people’s expressions seem to suggest that they think of my breed as if we were aliens from outer space. And I’m pretty much convinced that another group think that writers, technical or not, must have their heads examined.

I sometimes wish I had some power to read peoples’ thoughts on this subject – I’m sure most of it will not be very complimentary. Some expressions seem to say, “Poor girl! Maybe she did not have her father’s gift with numbers.” or “I hear her husband is in the software line – he must be an engineer.” I’d love to tell such people that he’s a technical writer too!

But who knows, perhaps some do think in a complimentary fashion, “She has her mother’s gift with words, I suppose.” Just wonder if there’ll be a day when my breed gets this reaction, “Wow! A technical writer? That’s so cool!” Till such time, I’ll fight my battles and console myself saying that people are indeed getting to be more aware of technical writing and the role of technical writers in various industries.

In my next blog post, I will talk about the top three things that people ask me about technical writing for software applications. That’s of course, when they get beyond their head-nodding and not-so-optimistic looks and actually begin to see that people can actually build decent careers in this line of work.

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

    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.