Technical Report - PowerPoint by rt3463df

VIEWS: 50 PAGES: 17

									Technical Reports

  for final term projects
               Formal reports
           others outside your group
written for
meets readers’ needs
image
standard parts and order
                    Format
meet technical rather thanartistic needs
use Nortel format (hanging head)
use good document design techniques
                            Style
professional
   not   stuffy, pompous
plain English
                            executive   everyone
no slang
use the jargon    of your
 audience
                    Content
cover/title page
summary
introduction
discussion
conclusion
recommendation (will  come after introduction)
references/bibliography
annexes/appendices
                 Summary
1 page    for college TRs
after title page and before TOC
summarizes problem, discussion, conclusions
 and recommendations
as few words as possible
hard to write
placed first, written last
                  Summary
tone
  interesting

  enthusiastic

  convincing     informative   brief
purpose?
                 Introduction
prepares reader  for discussion
numbered page “1”
semi-technical
includes (not nec. in order)
   Purpose

   Scope

   Background
                    Purpose
why the  project was carried out (main problem)
why the document was written
who authorized the work
what is the main result
   recommend    a solution
   investigate a problem

   introduce a new concept
                     Scope
defines what   the document will cover
describes how the work was done
sets limits to the report and why those limits are
 reasonable
includes a glossary/tells reader where the
 glossary is (at the end of the document)
                  Background
gives information reader must      have to understand
 the report
  description

  theory

  reference   to other documents
      completereference list appears at end
      documents may be included in annexes/appendices
                   Discussion
usually largest part
facts, arguments, details, results of   data
a lot of   info  must organize well
   beginningmiddleend
                   Discussion
review and   decide on your format
  chronological   p. 168 T-W!
  subject         p. 169 T-W!
  concept         p. 170 T-W!
            Discussion hints
use subheadings
maintain consistent hierarchy
keep “heavy stuff” inan annex unless it is
 necessary for the reader to understand
summarize heavy stuff and add to report if
 necessary
discussion subsections start with a mini-overview
 and end with a mini-conclusion
                Conclusions
state major   inferences drawn from discussion
do not introduce new information
state main conclusion and then lesser
 conclusions
do not tell the reader “what to do”
               Recommendations
        more work remains to be done
valid if
be strong, not bossy
   first   person/active voice
don’t introduce new information
see esp. Figure 6-10, p. 210 T-W!
                 References
use see T-W! p.   178–183/ p.207


                   Appendices
“heavy stuff”
must be  relevant
must be referred to from the text
not “everything but the kitchen sink”

								
To top