Professional Documents
Culture Documents
Cdi 5 Technical Writing
Cdi 5 Technical Writing
REPORT WRITING
1
Technical Report Writing
1
THE SUBJECT MATTER – is the matter presented for
consideration in discussion, thought or study.
1
The writer of a report must have a specific reader or group of
readers in mind.
1
This is the objective information of a written
material.
3 from criminology,
education and the like.
military, business,
QUALITIES OF A GOOD TECHNICAL REPORT
Not only does a technical writer is required to have good writing skills, but also his technical reports must have good
qualities that are appropriate and relevant. Brevity, clarity, completeness, and accuracy are the essential qualities in
order to achieve this.
1
BREVITY – this is the quality of writing which is characterized by the shortness or
briefness of the writing material; this is achieved through presentation of ideas in a short
but complete manner. Not all readers have the luxury of time to read and reread a
particular text, materials that are briefly completely written may help readers save time.
2 CLARITY – this is a condition of writing where ideas are simplified by making it easier for the readers
to understand. This is achieved by providing further examples, illustrations, or diagram in order to
clarify the text. A conscientious writer considers that not all readers are well-versed with specific
terminologies, it is his responsibility to convey his ideas as clearly as possible.
3
COMPLETENESS – this is a quality of writing where the ideas in the paragraph are
entirely and absolutely free from inconsistencies and errors in any form. A good writer is
aware that one of his objectives is to present information that is entirely complete
ACCURACY – this refers to the exactness and correctness of writing, as this is a result from
precision, conformity to grammar, and adherence to writing standards. There are writers who
4
know how to present their ideas, but they are inaccurate in presenting facts. An effective writer is
someone who is not only good at presenting his ideas but also accurate in conveying all the
complete facts. A well-writer report is a product of an accurate writer
THE TECHINICAL
COMMUNICATION
15
16
THE TECHNICAL COMMUNICATOR
17
CHARACTERISTICS OF A
GOOD TECHINICAL
COMMUNICATOR
A good technical communicator is a
person who has developed his good
writing skills, has mastered all the
conventions of the written language, and
has good characteristics.
19
CHARACTERISTICS OF A
GOOD TECHINICAL
1.
COMMUNICATOR
Knows his audience well – a technical writer who knows his/her audience well, and is in
the position to suggest and implement solutions to problems that nobody else identifies.
3. A generator of truth – a technical writer chooses what will be written, with the full
knowledge that later readers will depend on the accuracy of what has been written.
4. A good teacher – he excels at explaining difficult concepts for readers who will have no
time to read twice.
5. Has an excellent eye for details – he knows punctuations, syntax, and style, and can
explain the rules governing them.
20
Continuation:
6. Knows how to coordinate – though he works on his own much of the time, he also knows
how to coordinate with the collaborative work of graphic artists, programmers, printers, and
various subject matter experts.
8. Knows how to gather information from existing documents and from subject matter
experts.
9. He is respected and credible- he is a person with credibility, and he is also a valuable and
reliable source of information.
10. Has a strong language skill – he understand the highly evolved conventions of modern
technical communication.
21
TECHNICAL DOCUMENTATION
22
THANK
YOU
VERY
MUCH