Innovative approaches in Technical Writing


I am a regular visitor of cherry leaf technical writing site. I came across an interesting post that talk about innovative approach for a Samsung mobile user manual. Though this approach is a bit costly, potential clients will definitely get benefited. 

I just tried rubbing my brain for the possibilities of innovations in the technical documentation so that the clients will get benefited.

Include videos in the online help:

Imagine you are writing a 10+ steps procedure on how to create a Macro in the MS-Word or a Conditional text in the Adobe FrameMaker. When a procedure goes lengthier or more complex, it’s always a good idea to include a video or a flash file in the online help itself. I really bet you, clients will be accessing your video rather than reading your meticulous 10+ steps procedure.

A picture is worth of thousand words where a video is worth of thousand pictures.

Give a personal touch on your videos:

While including videos, it is good to have your own voice recorded. As you will be the best person to understand and simulate a complex procedure, it is good to have your voice as background than opting for a third-party voice recorder or dubbing. Of course, you are reducing the production cost for your client you know.

Annotate your images:

Preparing Requirement documents for the QA people is one of my regular activities. I use SnagIt for capturing images to support my procedures. I started using SnagIt’s annotation features in the captured images that gave a better understanding the requirement. I got an overwhelming feedback from the QA people. Let me illustrate with an example:

Rather than explaining the above fields one by one, capturing and annotating the image brings better clarity and reach among the audience.

Advertisements

One Response to “Innovative approaches in Technical Writing”

  1. Subhashini Says:

    3rd point is a valid one Renga. (i.e) annotating the images

    Subha

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s


%d bloggers like this: