Introduction to Technical Writing

By: Miquiel Banks
Submitted: 2007-01-17 16:42:59
Print this article | Tell a friend | For publisher | Social Bookmarking
Rating:
 

Officially, we can say that technical writing has no beginning because any person could conclude “the hieroglyphics” were writings of technical caliber to communicate to an audience. And they would be right.

First, we must simplify what we do. Technical writers create documentation using various platforms for a field and/or technology. I am using the word platform because our ever changing world of technology provides several types of mediums to deliver information.

After that, we strive for effective communication through the most efficient means because the purpose of communication is to disseminate information. The technical writer, based on his/her knowledge and experience, chooses the correct platform or medium to release this information.

To adequately present the information accurately and with the most efficiency, we must first understand the following:

* Requirements (optional)

* Audience

* Purpose

* Platform

* Structure

* Content

The Requirements define WHO, WHAT, and WHY in such a limiting fashion, the following points (audience, purpose, platform) are integrated in this step. This step is optional and very prevalent in the telecommunications industry.

The audience defines WHO we are writing the content for. This information dictates the JARGON AND TECHNICAL LEVEL OF OUR STYLE.

The purpose defines WHY we are writing the content. This information dictates the TONE AND COLOR OF OUR STYLE.

The platform defines HOW we are delivering the content. This information usually dictates the SOFTWARE CHOICE.

The structure defines WHICH WAY we are writing. This information dictates the technical aspects of writing (FORMATTING, COLOR, WORD USAGE, PRESENTATION) of our content.

The content defines WHAT we are writing. This information dictates the text and/or messages/meaning of what we are doing. For instance, a document could be created that presented a company’s statistics for the year and without much text, this document would be pages and pages of charts, graphs, and tables. In this instance, these graphics would constitute the content of the document.

The reason why content comes last is that if you change the order, you risk creating problems, adding more time (always a NO-NO), losing effectiveness and efficiency.

Miquiel Banks has nearly a decade of experience in technical writing and has mastered many areas of this mis-understood career choice. Visit his site at http://www.kemetmediaweb.com for profound advice, guidance, and genuine concern for all your ebook needs. To receive all the benefits, sign up for the KEMET MEDIA newsletter at kemetmedia@gmail.com and putting the word "SUBSCRIBE" in the heading of the email.

Article source: Expert Articles

Most Recent Articles in Writing & Speaking category

  • Journaling Demystified - By: Anil Yadav
    Have you been considering journaling, but have questions about how to get started? Journaling is a wonderful way to explore your faith through prayer, reflection and personal narrative. Shared here are some of the popular questions about journaling, and the opportunity to formulate your own answers to see if journaling fits for you and your journey.
  • 5 Linking Strategies that Work - By: Het Ram
    One of the most effective ways to promote your business online, especially if you use search engine optimization to build traffic, is linking.
  • 5 Questions to ask before purchasing a book online - By: Het Ram
    What is it you want to order? Have a clear idea of what you want to order. Do you want to browse through a category, or do you want to read a particular author or do you know the name of the book itself.
  • Secrets to Creating Great Headlines - By: Nisha Garg
    Great! You finished your piece and now need a headline. Usually headlines are less than ten words and need to be expressed in short, expressive, active words. This provides quick focus and pull in. By waiting until you know what you are ending up with, it will save you time. You can give a temporary headline while drafting.
  • 5 Ways to Generate Article Topic Ideas - By: Dolly Kapil
    If you write articles frequently, you have probably found that sometimes you just don't know what to write about. This is a very common issue for even the best of us; however there are some quick tricks that can help.
  • How to Get a Book Published - By: Robert Nahas
    "How to publish a book" is a common quandary imposed upon thousands of aspiring authors on a daily basis. Not knowing how to publish a book stops many from pursuing their book dream. Not knowing that you have many publishing options available to you today can make the difference between great success or miserable failure with your book.
  • Writing Your Sales Pitch - Is the Standard of Your Web Content Affecting Your Sales Potential - By: Paul Docherty
    There are lots of resources out there for web designers; just do a web search and you'll find all manner of tools and guidance to help get your website up, running and looking professional.One area that many webmasters forget or don't realise that they need to be aware of is the standard of their written content in terms of language, punctuation and grammar. Many web sites are sales oriented and so the standard of written content becomes crucial to the success of the sales pitch.
  • How To Research Your Topic For Your Publication - By: Arlene Whiting
    Last week's article gave some foundational steps for “How To Choose Your Topic.” This week’s article deals with how to research your topic.First things first, you have your topics before you and you want to go to the library to the card catalog or you can do this from home.
  • Top Sales Speaker Says: Only Fakes Have No Stories To Tell! - By: Dr. Gary S. Goodman
    I was just gazing at an article I submitted a few minutes ago when something hit me.I tell one story after another, and I’m proud of that.Each one comes from an experience I’ve had, not simply from a book I’ve read, or another article that I’m imitating.
  • Verb - By: Sharon White
    The sound-replacive type of derivation and the stress-replacive type of derivation are unproductive: food — to feed, blood — to bleed; 'import — to im'port, 'transport — to trans'port. The typical suffixes expanding the stem of the verb are: -ate (cultivate), -en (broaden), -ifу (clarify), -ise(-ize) (normalise). The verb-deriving prefixes of the inter-class type are: be- (belittle, befriend, bemoan) and en-/em- (engulf, embed).