Technical writing is a form of technical information used in variety of fields

such as software, technology, engineering, project planning and many more.

A technical document which is generally written by researchers is the
delivery of technical information to the audience in such a way that it is
easily understandable and straight to the topic. A good technical document
serves the purpose of a particular scenario by offering recommendations and
conclusions appropriate.
The technical documents can be any of the following types:

Annual reports: It is a report on companys activities in a given year.

The intention of this report is to give the information about state of the
company and its financial condition to the shareholders and other
interested people.

White paper: A white paper is a document that is proposed as a way

of finding a solution in a particular situation. It offers a detailed
information about the present condition and the proposed solutions to
that situation and guidelines to overcome it

Planning studies: This type of document generally provides the

information about the structure and the flow of studies in a particular
institution.

Training materials: These documents are generally provided to the

individuals that takes part in trainings and this document helps them
to get through the

Research articles: The research study of the researcher is presented

in this type of documents. It contains the information such as present

The ideal report structure is as:

Title Page: The title of the report and the author name is written in
the middle of this page and rest of the page is left intentionally.

Summary/Abstract: It is the brief summary of the research in the

document and it has:
o Purpose: The topic of the research study is described in the
document and the purpose of writing this document.
o Methods: This section describes the methods that you have used to
do the research and how.
o Results: The outcome or the result of your research is described in
this section.

Table of Contents: List of all chapter headings, tables, images and

references etc. that are to be discussed further in the document.

Introduction: A good introduction should provide the reader a clear

view of the intention of research on the project and should contain
o Need of the document
o Aim
o Scope/outline of the document
o Strategy to be followed
o Future enhancement in the area etc.

Main body: This is the section of the report where you present your
work in detail about a particular project. It starts with introduction and
ends with the conclusion acting as a frame for the documentation. The
flow of information should be such that the reader should easily
understand the flow of the information. The body:
o Present your
information

research

with

both

practical

and

theoretical

o Arrange information logically under suitable headings.

o Can use images and tables for better conveying of your information

References: This gives a list of websites and links that you have
referred to gather the stuff and able to present it in your report.

The document can be divided into 4 divisions:

Planning: It refers to the intended audience and what is the goal of

writing this technical document.

Content: It is the content of the whole document which includes, what

are the chapters that are to be covered and the sources of the reliable
information from where you can gather the content for your document.

Writing: After collecting the information from different sources, its the
technical writers duty to analyze and summarize the information and
try to present it in an effective manner.

Review : After finished writing the document you have to review it

once or twice to get the better understanding of the writing

General Guidelines:

Use examples whenever necessary

Stick to your topic

http://www.monash.edu.au/lls/llonline/writing/engineering/technicalreport/5.xml
http://library.bcu.ac.uk/learner/writingguides/1.02%20Reports.htm
http://docs.writethedocs.org/writing/beginners-guide-to-docs/
http://en.wikipedia.org/wiki/Technical_writing
http://homepages.inf.ed.ac.uk/jbednar/writingtips.html