Professional Documents
Culture Documents
The Alphabet of Technical Writing
The Alphabet of Technical Writing
A: Accuracy. This can be attained by guarding against careless thinking, expressions and
calculations.
B: Brevity is conciseness of expression, checking the development of your own ideas and
accuracy of expression.
C: Confidence. If you believe in what you are saying is right and wise, write it. Have trust
in yourself.
D: Dignity. Particular attention should be given to diction. Avoid using contractions like won’t,
shouldn’t, can’t, don’t. Use straightforward expression with summarized, simplified and
well-organized information.
H: Honesty. Proper documentation must be used. A technical writer must acknowledge his
sources.
K: Knowledge. The communication of knowledge is one of the chief functions of the report. It
is more than a collection of data for it involves interpretations and formulation of conclusions.
Without intelligent interpretation, data will remain useless.
L: Logic The process of showing the relations among groups of things and classes of
group is logic. It is a process of classification, putting things in their proper places.
M: Mechanical Neatness. A report should be neatly typed and well margined so that it will be
easier to read. Headings, subheadings and indention are mechanical devices which
help to make the organization of the content clear. Your report must then be clean, free
from typographical errors and erasures.
O: Objectivity can be achieved if you avoid the use of first person in order to give the
impression that the work being reported is a team effort or a company activity.
P: Planning. You need to have a clear idea of where you are going to end before you
begin writing.
Q: Qualification. Qualify what you write by describing what factors are constant and what
factors are viable as you work.
R: Revision. It is the most important phase of technical reporting aside from planning,
designing, rough drafting.
S: Straight Sentences, In a good report, each paragraph begins with a straight forward
statement of its subject.
U: Unity. A unified report is one in which everything is clearly relevant to main point
under discussion.
Source:
https://www.scribd.com/doc/102731262/The-Alphabet-of-Technical-Writing