Purpose, Content, & Organizational Patterns of Common Types of Technical Documents
Purpose, Content, & Organizational Patterns of Common Types of Technical Documents...continued
Elements of Various Technical reports
Elements of Various Technical Reports...continued
100
What is the goal of a technical writer?
To explain technical information clearly, concisely, and in simple language
100
What does a report do?
Communicates information, which has been compiled because of research and analysis of data and issues
100
What do feasibility reports do?
Provide information and argue the point of certain course of action
100
What does the title of a report need?
To be detailed so there is no question as to what the report is about.
100
What are recommendations often included in?
Reports that include results of test experiments, field trials, specific design problems and feasibility reports
200
When in the writing process should a technical writer know their audience?
Early
200
What do progress reports do?
Explain the progress of a given project or several projects
200
What do research/laboratory reports include?
Scientific information that is gathered during a study
200
What is a summary/abstract?
A brief overview of the report
200
What do graphics in a technical document help the reader understand?
The instructions of a technical document
300
What is it important to think about when writing?
It is important to think about and focus on what matters to the reader
300
What do progress reports assure.
They assure recipients that progress is being made, that the project is working smoothly, and they tell of the expected completion date
300
What is a resume?
A document that lists the set of your professional and personal accomplishments.
300
What are headings?
Important features to a technical report because they help break up long stretches of straight text
300
Where should each new type of data or procedure/technique be found?
In its own appendix
400
What is the purpose of writing a document?
To convey information
400
What do inspection reports do?
They explain the condition of the item that is being inspected as observed at the time of inspection
400
What is a manual?
A document that serves as a training tool to educate the reader how to use, run, install, set up or build a tool/product
400
Where should definitions be placed?
In endnotes or in the glossary at the end of the document
400
What does the page design cover?
A wide range of reader aids, including white space, bullets or numbering, indentation, underlining, bold facing, capitalization, headings, subheadings, and visual aids
500
What is the necessary thing to do when writing a document?
To research online and make sure the information you are presenting to the reader is valid
500
What is a memo used for?
It is used for communication within a company
500
What is a proposal?
A written document, which includes a suggestion or recommendation on a plan
500
What should the conclusion section state?
Whether you have achieved your objective, a brief summary of important information and findings and highlights the outcomes and results of your investigation and the significance.