You are on page 1of 9

Quaid-E-azam collagE of

EnginEEring TEchnology
Sahiwal
affiliaTEd wiTh uET
lahorE

Assignment For HU-121 Technical


Writing & Presentation Skill

Subject
Aspects Of Technical
Report Writing

Submitted To
Sir HAIDER FAROOQI
Submitted From

Mechanical Engineering 2nd semester

 ABDUL SALAM
EN19313
Content list

 What Is Technical Report


 What Is Technical Report
Writing
 Technical Report Elements
 Tips On How To Write A
Technical Report
 How Best To Present Your
Report
 What Is Technical Report

Today technical writing encompasses all documentation of


complex technical processes. It includes reports, executive
summary statements, briefs. Any time technical
information is conveyed in writing at work, it is, by
definition, technical writing.

"A technical report is a document written by a


researcher detailing the results of a project and
submitted to the sponsor of that project." TRs are not
peer-reviewed unless they are subsequently
published in a peer-review journal.”

 Characteristics
 May contain data, design criteria, procedures,
literature reviews, research history, detailed tables,
illustrations/images, explanation of approaches that
were unsuccessful.
 May be published before the corresponding journal
literature; may have more or different details than its
subsequent journal article.
 May contain less background information since the
sponsor already knows it
 May have restricted access
 May contain obscure acronyms and codes as part of
identifying information
 Classified and export controlled reports
 What Is Technical Report
Writing

Definition
Technical report writing is a type
of writing where the author is writing about a particular
subject that requires direction, instruction, or explanation.
This style of writing has a very different purpose and
different characteristics than other writing styles such as
creative writing, academic writing or business writing.

 Characteristics
 It is clear and straight forward. If you are interested in
technical writing for professional purposes, it is very
important to know that this type of writing It is very
structured.

 This type of writing has a very obvious composition that


makes it easy for the reader to follow along.

 Solid structure is needed with technical writing as it


allows the audience to easily access the information as
needed.Requires that the writer stick to the subject
matter and relay information in a clear and concise
manner.

 It is very detailed and informative. The perfect example


of technical writing is a textbook. The written content of
most textbooks is geared to providing information by
describing the subject matter as fully as possible.
 Technical Report Elements

 The title page


 The introduction
 The summary
 Experimental details
 Results and discussions
 The body
 Conclusion

The conclusion may include:

-Recommendations
-Reference
-Bibliography
-Acknowledgments
-Appendices
 Tips On How To Write A
Technical Report

A technical report doesn’t differ much from other


types of technical documents. First steps are the
same — learn your audience, goals of the technical
report, what re courses (articles, blogs) can help you
write a good report, and so on.
Then list all your ideas of topics as they come to your
mind, sort them into groups — it will be a rough
outline of your future technical report. Now, you’re
ready for a first draft. I want to provide you with some
tips on how to write a good technical report in order to
help you create a great first draft and save your time:

 When you’re searching for information on the Internet,


keep in mind, that not all the information is reliable, so
check it twice. The best way is to read relevant books,
journals, and articles.
 Speaking of formatting, stick to one format — don’t
use different fonts in your work. If you want to
highlight an idea, use bold or italic.
 Heading and subheadings should be clear in order to
ease the searching for necessary information. They
also help readers get the main idea quickly. In my
recent post called ‘Using Humor in Technical
Documentation’ I showed an example of using humor
in the table of contents, and it’s not a good idea —
nothing is clear.
 It’s ok to use the information of other people but use
citation — plagiarism is not a good idea of writing
content. Check out Top 10 Free Plagiarism Detection
Tools in order to be sure that you cite all sources.
 Proofread your content using these tips or a free
grammar checker.

 How Best To Present Your


Report

A presentation is important part of the final outlook of


your work. So, what do you need to do:

 Write a script. Your report should be printed on an A4


paper on one side. It should not be hand-written
because it’s not accepted.
 You should number those pages that contain the
content, so, a title page and a summary are
exceptions.
 Staple your report at the top left; if a report is too
long, you should bind it.
 Formatting: usually the font size is 12, style is Times
New Roman, the spacing is 1.5 or 2.
THANK YOU

You might also like