Translate

Monday, April 18, 2011

An unedited article on Technical Writing


Technical writers explain technology and related ideas to technical and nontechnical audiences. This could mean, for example, telling a programmer how to use a software library or telling a consumer how to operate a television remote control. Technical writers gather information from existing documentation and from subject matter experts. Technical writers are often not SMEs themselves. Technical writers themselves may be called API Writers, information developers, documentation specialists, documentation engineers, or technical content developers. Advanced technical writers often move into specialized areas such as API writing, information architecture or document management.
Misconceptions about Technical Writing:
Misconceptions: Technical writers are confined only to Software and Hardware industry.
Fact: Technical writers are not merely confined to Software and Hardware industry as they can be found in various fields such as Aeronautical, Robotics, Pharmacology, electronics, and tele-communications.

Misconceptions: Technical writers simply prepare User Guides or Instructions
Fact: Though they mainly prepare User Guides and Instruction write-ups, their job consists of various responsibilities.

The write-ups of technical writers can be classified into two categories:
  • End User Assistance write-ups
  • Traditional documentation

End User Assistance write-ups: The write-ups are meant for assisting/guiding the end user.
  • User Guide/User Manual
  • Help file
  • General Instructions

Traditional documentation:
  • Case studies
  • Test cases
  • Technical documents
  • Reference literature
  • Articles on technical issues and research papers

Your business write-up acts like a sales person. Your investment on your website is like a longterm investment and it keeps on generating you revenue for years together.


No comments: