Build your professional network on facebook via our app Go to app
 
 
Posted in Community :

Technical Writer

 
technical writing by Anand.Rajaraman, Sr.Technical Writer, Reflexis Incorporation (Retail Execution Management)

technical writing

By : Anand.Rajaraman, Sr.Technical Writer, Reflexis Incorporation (Retail Execution Management)
Industry : technical writing Functional Area : technical writing
Keywords :

Technical

Technical Writing

Activity:  0 comments  188 views  last activity : 07 06 2010 20:18:04 +0000
 Refer 14
Share
 
 
 

How to Outline Technical Writing Documents

By eHow Business Editor

A well-written document isn't created by chance. The material covered in a report, manual or other technical document is planned, organized and then written. The outlining stage of a document is a key step and chances are the information won't be presented logically if an outline isn't created. Outlining gives the author a chance to think about the information that should and shouldn't be included.

Step1Brainstorm your ideas. Write down any ideas in your outline that you think should be included in the technical document. Don't be concerned with the order of the information. It just matters that all of the information is included in the brainstorming process.

Step2

Determine the purpose of the technical document. Ask yourself questions such as who will be reading the document, why will it be read and how will it be used.

Step3

Decide what type of outline you would like to create: historical, chronological, specific to general, small to large, simple to complex or any other form appropriate to the content. Think about the audience and about the information that you want to present. Make sure that the way the information is arranged makes the most sense to the type of information being presented and to the audience that will be reading the technical document.

Step4

Arrange the information in the appropriate order. An outline involves grouping the information into logical sections and levels. You can create main topics and sub-topics and sub-sub-topics.

Step5

Finish the outline by reviewing the information to verify that the subjects are organized appropriately and logically. Make sure that you aren't missing any key facts. Delete any information that isn't relevant to the technical document.  
go to top
 
0 comments on "technical writing"
Sort by: Most Recent Top Rated
Add your comment on "technical writing"

Rate:
Submit
 Found the article "technical writing"  interesting ?  Share with your connections and communities  
Recruitment firm for Telecom Professionals
ESXi Drivers
ESXi Drivers
Linux Drivers (Kernel Space)
Viewers also viewed
Technical writing vs Content/Blog writing
 
561 referals 10 arguments, 481 views
Fundamental Analysis vs Technical Analysis
 
346 referals 13 arguments, 461 views
should be there.... vs Not neccessary
 
2126 referals 34 arguments, 723 views
more...  
Recent Knowledge (94)
Today i saw a post on yahoo : http://in.lifestyle.yahoo.com/10-ideal-habits-better-lifestyle-074...
 
648 referals 10 comments, 379 views
Let me share a few issues for TS members. Demarcation of the boundary was initially made with...
 
293 referals 3 comments, 33 views
NANDKUMAR B.SAWANT.,M.COM.LL.B.(MUMBAI),ADVOCATE MOBILE.09325226691, 09271971251...
 
24 referals 17 comments, 11573 views
more...  
Sponsored Jobs
More From Author
Hi Dipti
Yes, I go with Sulagna Brahma, US might bring many reforms in terms of healthcare , employment. But they cannot sustain and run their policies on a long term basis..
Your votes are valuable. Think twice before you cast your vote. Maybe you can see this video (http://www.youtube.com/watch?v=etzaBnSa37o) and select a candidate like him from your constituency.
more...