|
Technical Writing -
Treating a document with the goal of providing clear and concise
information, rather than entertainment or story telling; a technical
document/report incorporates diagrams and multi-media information to
provide technical information.
•Reports
need to be neat, organized and word-processed.
When done someone could
read your report and duplicate the results.
Written in third person with no pronouns.
•TITLE
PAGE:
•Title
of project, names of student participants, course title,
institution were work was done, date.
•A
summarization of the report.
This summary should include the objectives of the
project and what was accomplished.
This summary should be short and to the point
with specific information and one paragraph in length.
•All
sections listed in order with page numbers to
find the information.
•Should
be a brief explanation of the project or
activity.
What is the purpose of the activity?
What are you going to learn and what are
you going to do?
•Information
and background research of the topic.
Information gathered in order to
accomplish the task.
What you studied of previous
research and designs done by others.
Explain why your work is
different.
•List
of materials needed to do the project or
activity.
•Details
on how you did the lab, activity
or project.
Step by step process
showing sketches, schematics,
equations, photos, etc.
This written part needs
to be very specific as to your
step by step procedure as well
as what you learned in each of
the steps.
This section may be
broken into subsections.
•How
well did you accomplish
your objectives? Discuss
suggestions for
improvement and errors
and problems that
occurred during the
process.
Where could this
project go in the
future?
Do the results
agree with your purpose?
•Brief
explanation of what you
learned and what the
activity
was all about.
•This
section should include
Drawings orthographic,
isometric, assembly,
schematics, exploded
views, written programs,
flow charts, and tables
of information pertinent
to the report but too
large to fit in the
written documentation.
•Books,
magazines, journals,
Internet sources, etc.
that were used to obtain
and learn information.
Since this is a
technical report the
format should follow APA
guidelines.
|