Theory & Practice
Purpose/content
organization/patterns
Different Elements
Technical Editing
100
What helps a writer to ensure validity?
When the writer his/herself can understand the information being written about.
100
What is a technical report?
information that has been compiled because of research. Tells of important outcomes of data and/or issues.
100
What is a manual?
A document that teaches the reader how to use, run, or install a particular tool or product.
100
What must be included in a title?
A detailed word or phrase so there is no question as to what the report is about.
100
Why is clarity important?
because it is used to convey the exact meaning of your paper to the reader. People won't understand your writing if the meaning isn't clear.
200
What is the purpose of writing a document?
To convey important information.
200
What is a progress report?
It is used to reassure that progress is being made and that a particular project is running smoothly. It should also be honest, including any problems occurring as well.
200
What is written in instructions?
Steps that direct you in a project (often in the present tense).
200
How long should a summary of a report be?
Only a few sentences.
200
What must be done to ensure that a report is complete?
It must be edited.
300
Once you complete your documentation, you need to...__
Test it to make sure your reader can understand what you're writing.
300
What is an inspection report and what should it include?
Inspection reports should explain the condition of the item being inspected. it should include any major concerns, safety issues, and needs of improvement.
300
What is included in Procedures?
Short, descriptive sentences, and bullet points.
300
When is it okay to use headings?
When they make a technical report easier to understand. never overdo headings.
300
What does it mean for a report to be correctly written?
It should tell a complete story as logically and interestingly as possible.
400
What is the goal of a technical writer?
To explain complex technical information clearly, using simple to understand language without lower level words.
400
What is a feasibility report?
A report that provides information and argues a certain course of action. Includes opinions about how to solve a particular problem.
400
What are process descriptions?
Manuals that include instructions in a series of events. numbered in the order of which they occur.
400
Roughly how many headings are acceptable per page?
Two to three.
400
What is unity?
A document has unity When there is an exact point or the document. Each paragraph should concentrate on a single concept with supporting points.
500
What should a technical writer focus on during the writing process?
He/she should focus on whatever matters to the reader.
500
What type of writing would you use for correspondence?
Memos and Resumes.
500
What are Proposals?
Written document that includes a suggestion or plan of recommendation. Should include a cover page.
500
Where should definitions of terms or concepts be included?
In the endnotes or glossary at the end of the document.
500
Why is tone important?
Because the writer wants the reader not to feel confused or uncertain with the information. A good tone should be informative and confidential.