Continued Elements of Various Technical Writing Reports
Technical Editing
Theory and Practice of Technical Writing and Miscellaneous
100
This type of report explains the progress of a given project or several projects.
What is a progress report?
100
This part of a report needs to be detailed so there is no question as to what the report is about.
What does the title of a report need to include?
100
Anything that cannot be left out of a report, but is too large for the main part of the report and would serve to distract or interrupt the flow belongs in this place.
What information belongs in an appendix?
100
Writing with this style in mind includes informing the reader of the exact meaning of a document with clear and understandable text.
What is Clarity?
100
A written document, which includes a suggestion or recommendation on a plan
What is a proposal?
200
This type of report explains the condition of an item being inspected as observed at the time of inspection
What is an inspection report?
200
This part of a report is a brief overview of the report
What is a summary/abstract
200
This feature covers a wide range of reader aids, including white space, bullets or numbering, indentation, underlining, boldfacing, capitalization, headings, subheadings, and visual aids.
What is included in page design?
200
Writing in a brief and comprehensible way
What is Conciseness?
200
A document that serves as a training tool to educate the reader how to use, run, install, set up, or build a tool/product.
What is a manual?
300
This type of report provides information and argues the point of a certain course of action
What is a feasibility report?
300
This part of a report is an important feature to a technical writing report because it helps to break up long stretches of straight text (There are first, second, and third levels of this part of a report)
What is a heading?
300
This type of feature presents information in columns and rows
What is a table?
300
This refers to a single purpose and presentation of information in a document
What is unity in writing?
300
The purpose of writing a document is to convey information, you will need to understand the information yourself to give instructions
What is the importance of ensuring the validity of writing?
400
This type of report includes scientific information that is gathered during a study
What is a research/laboratory report?
400
This feature is often included in reports that include results of test experiments, field trials, specific design problems and feasibility reports. The author may suggest a course of action to the reader, such as if any additional information needs to be learned and what the author wants the reader to do with the information presented
What are recommendations?
400
This type of feature simplifies statistical data
What is a graph?
400
Presenting information in a logical way using patterns or methods of development to create a readable document.
What is Sequence?
400
The writer must know the audience early in the writing process. This helps create an objective and writing style for the intended audience.
Who must the writer know early in the writing process?
500
Memos, Letters, Resumes
What are three types of correspondence?
500
Using this visual feature in a technical document helps the reader understand the instructions of a technical document
What are graphics used for?
500
A catch-all term for many kinds of visual aids
What is a chart?
500
Telling a complete story as logically and interestingly as possible.
What is correctness?
500
To explain complex technical information clearly, concisely and in simple language, so the average reader can understand the information