Chapter hvac engineering Fundamentals: Part 1 Introduction

Technical Report Writing
441
The whole of Section 1 should not exceed two or three pages, one or
two figures, and a summary table.
The rest of the report is composed of detail, as complete as possible
but not verbose. Note that the summary follows the same sequence as
the body of the report. Lengthy data summaries and calculations
should be placed in an appendix. This material exists only to prove
the conclusions of the report.
15.3
Writing with Clarity
Technical writing deals with factual data in objective, nonemotional
ways for the purpose of presenting information on which to base de-
cisions. Most technical reports are written not only for technical people
but also for management and financial people, who may understand
very little about the technical aspects. It is therefore necessary to use
technical detail but to express it in simple terms, so that the audience
can at least understand the principles involved.
The following suggestions should be helpful:
1. Technical terms should be defined or made clear in context.
2. Proceed stepwise, from the known to the unknown. The use of syl-
logisms, as employed in logical proof, is sometimes helpful. A syl-
logism consists of two
premises
or facts which, taken together, lead
to a conclusion. When the steps become very detailed, complex, and
lengthy, it may be desirable to simply say, ‘‘It can be shown.’’ The
proof can be included in the appendix, if needed.
3. Make sentences as simple and direct as possible. Avoid overly com-
plex sentences with many phrases or clauses.
4. Writing should be factual. Any opinions expressed should be based
on the writer’s proven expertise and should be identified as opin-
ions. Avoid subjective and emotive adjectives. These have no place
in technical writing. Also avoid phrases like
it is clear that
or
it is
apparent.
Do not use cliche´s.
5. Follow accepted grammatical rules concerning punctuation, syntax,
agreement, and case. Grammatical errors reduce credibility.