Types of Documents
Elements of Technical Reports
Technical Editing
Technical Editing cont.
100
A document that communicates information which has been compiled because of research and analysis of data and issues.
What is a Report?
100
A detailed word of phrase that describes what the report is about. Appears on the front page along with the author's name and date of the report.
What is a Title?
100
Conveying the exact meaning to the reader; must be clear and understandable.
What is Clarity?
100
Included in this are white spaces, bullet points, indentations, underlining, and headings.
What is Page design?
200
A document that explains the progress of a given project or several projects.
What is a Progress/inspection report?
200
A brief overview of the report, states the main topic, purpose, investigations, results, conclusions and any recommendations.
What is a Summary/abstract.
200
A technical document must be edited to make sure this is true. Another word for having everything done and accounted for.
What is Completeness?
200
Reports should tell a complete story as logically and interestingly as possible.
What is Correctness?
300
A document that provides information and argues the point of a certain corse of action.
What is a Feasibility report?
300
An important feature of a technical report; help break up long stretches of straight text.
What is a Heading?
300
The element that makes sure everything is understood clearly; describes why you are describing something.
What is Conciseness?
300
Presentation of information in a logical way, creating a readable document.
What is Sequence?
400
A document that includes scientific information that is gathered during a study.
What is a Research/laboratory report?
400
All term that need to be defined should be included in this element. May be placed in endnotes or in the glossary at the end of the document.
What is a Definition?
400
An element in a technical document that helps the reader understand the instructions. Must be labeled, include a title, and a source if not your own.
What is Graphics?
400
This is the single purpose and presentation of information in a document.
What is Unity?
500
A document that serves as a training tool to educate the reader how to use, run, install, set up or build a tool/project.
What is a Manual?
500
An effective ending to a report; brief summary of information and findings of your investigation.
What is a Conclusion?
500
Information essential to the understanding and defending of the text. Information that needs more understanding such as definitions, should be included.
What is the glossary, footnotes, appendices, and indices?
500
The voice in your paper; should remain as informative and confidential.
What is Tone?