cutearticles.com cutearticles.com
Search:    Main Page >> About Us >> Privacy of Info >> ToS >> Place Your Link >> Add Article   
Add Url
 

Science & Research

Investment & Finance

Property & Agents

Online Shopping

Recreation

Drink & Food

Medicine & Treatment

Self Help

Art & Culture

Sports & Adventure

Lifestyle & Fashion

Business & Services

Jobs & Careers

Indoor Games

Events & News

Garden & Home

Academics & Education

Hotels & Travel

Fitness & Health

Vehicles & Automotive

Policies & Law

Internet & Computers

Teens & Children

Society & Issues


 

Main Page » Academics & Education » Vocational & Careers
 

Introduction to Technical Writing

 
Author: Miquiel Banks
 

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.

 
 
 

Related Articles

 
Interview for "13 Days" author Raven W. Night
 
Pumping Your Muse - Book Review
 
One Catch-22 of Internet Marketing For Authors
 
Worst Book This Side of the Year 2000: a Review of "Abduction"
 
Medical Assistant Careers on the Rise
 
Making Biodiesel at Home
 
DOE and NIH Teams to Unlock Power of Proteins
 
Boys' Boarding Schools
 
Confusing MAV Optic Flow Sensors In flight Using Mobiles
 
Environmental Sustainability - A Mirage?
 
 
 
   Main Page >> Privacy of Info >> ToS
Copyright © 2008 www.cutearticles.com