Vinish Garg

Technical Writer. Published Author. http://www.vhite.com

Growing as Technical Writer

with 4 comments

Technical writers generally enjoy their day-to-day tasks whether it is developing documentation prototype, writing instructions, reviewing a document (of self or others), or planning for a document publishing or release. My experience suggests that technical writers are so used to ‘feel-good’ factor that sometimes, the less experienced technical writers are ill-prepared to handle issues, conflicts, and question marks. Even if somewhere internally, they agree that ‘the change’ is in the interest of project, they are not ready for this “change”, when things are difficult. Beginners may respond differently, but they tend to follow how others ‘respond’ in that work culture. And it is an unwelcome sign.

I keep on emphasizing that it is very important to have a sound platform, and to understand technical writing in wider perspective rather than considering it as job of merely writing instructions for user manual. It does not call for a complete personality makeover (neither I encourage it nor it is required); however, individuals need to work on their thought process. Some useful points for growing into a good technical writer are:

  • Writers’ block – Treat it.
  • Understand the pulse of your project team.
  • Know your ability.
  • Smile. Your reviewer’s job is to find mistakes in your document.
  • Agree to disagree.
  • The smallest mistake can cause the biggest escalation.
  • There is no such thing as a perfect document (almost).
  • Love your document till you send it out.
  • Always Zero-in your focus on customer requirement and the basic objective of document.
  • Keep it Simple.
  • Always follow the style guide.
  • Be consistent in your thinking, planning and writing.

I recall that I read a few of these points somewhere. If anybody can help me connect to that, I would love to give credit to that source and person. Happy Writing!

Advertisements

Written by Vinish Garg

June 7, 2010 at 11:15 am

4 Responses

Subscribe to comments with RSS.

  1. Change following
    “Smile. Your reviewer’s job is to find mistakes in your document.”
    to
    “Smile. QA/QC person’s job is to find mistakes in your work.”

    Kumar Chetan Sharma

    June 7, 2010 at 2:03 pm

    • Chetan, a reviewer is anybody who reviews the document. It can be the documentation manager, program manager, project manager, or a test engineer. So what you suggest is included by default. Cheers!

      vinishgrg

      June 7, 2010 at 2:09 pm

  2. well my suggestion was generic or an abstract class 😛

    Kumar Chetan Sharma

    June 7, 2010 at 5:27 pm

  3. Interesting article Vinish, very informative and educative for a person who seeks knowledge in the field!

    I’m a newbie to the field and wrote about being a technical writer sometimes back. [ link ]

    Wish I had seen this post before I wrote the above post 😦

    deepsishere

    June 26, 2013 at 2:20 pm


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: