About This Chapter
Technical Editing & Rewriting - Chapter Summary and Learning Objectives
Technical writers have many tools at their disposal for making their writing as clear and accurate as possible, and editing and rewriting can be two of the most important. This chapter's instructors can help you achieve clarity and correctness by guiding you through the steps of proofreading and revising to fine-tune your technical writing. They can show you the importance of appropriate sequence, organization, unity and formatting. When you complete this chapter, you should feel comfortable with the following concepts:
- Simplifying for conciseness
- Revising for errors and readability
- Importance of accessibility in your writing
- Composing with technology
|Achieving Clarity in Technical Communication||Discuss achieving clarity by using details, defining acronyms or jargon, and by using active voice.|
|Organizing Technical Communication for Clarity||Outline the five patterns of organization for clarification, including spatial, importance, chronological, problem/solution and compare/contrast.|
|Achieving Correctness in Technical Communication||Explore the importance of grammatical and contextual correctness in technical communication.|
|Proofreading Your Message for Spelling, Grammar, Accuracy & Clarity||Detail methods to check for issues related to grammar, spelling, accuracy and ambiguity.|
|Simplifying for Conciseness in Technical Communication||Explain how conciseness can not only aid clarity, but also save time.|
|Revising Your Message for Errors, Conciseness & Readability||Address the revision of errors found in proofreading related to grammar, spelling, conciseness, readability and clarity.|
|Achieving Completeness in Technical Communication||Discuss proofreading for sufficient details needed for self-support and the process of citing external sources.|
|Ensuring the Technical Document is Accessible and Easily Understood||Identify checkpoints to ensure that technical writing is accessible to users, including syntax, length of sentences, minimum recursion and varied word choice.|
|Accounting for Sequence & Organization in Technical Documents||Explain the elements of clear organization, including headings, subheadings, lists of figures, tables of content, indices and using short paragraphs.|
|Achieving Unity in Technical Writing||Point out ways to achieve unity in technical writing.|
|The Importance of Message Follow-Up||Explore the importance and process used to check for understanding.|
|Using Technology to Help Compose Your Message: Formatting & Effectiveness||Outline how the use of word processing can lead to professional documents.|
|Giving and Responding to Constructive Feedback||Explain how to give and respond to constructive feedback.|
1. Achieving Clarity in Technical Communication
A lack of clarity in technical documents can lead to confusion and costly mistakes. This video provides tips on how to achieve clarity in technical documents.
2. Organizing Technical Communication for Clarity
People look for patterns in nature, life, and writing. This video explains the importance of using an organizational pattern in technical writing and provides examples of five organizational patterns.
3. Grammatical & Contextual Correctness in Technical Communication
One of the most important jobs of a technical writer is to make sure that the information published is accurate. This video provides tips to ensure that your documents are grammatically and contextually correct.
4. Proofreading Your Message for Spelling, Grammar, Accuracy & Clarity
One of the final stages of completing a business message is to proofread the communication for spelling, grammar, accuracy and clarity by completing different review options. Learn how to proofread in this lesson.
5. Simplifying for Conciseness in Technical Communication
Documents that are long and wordy are difficult to comprehend and often end up not being read completely through. This video provides strategies for keeping technical documents concise.
6. Revising Your Message for Errors, Conciseness & Readability
The three parts of producing a message are planning, writing, and completing. In the completing stage, it is crucial for business writers to examine their message for errors, conciseness, and readability.
7. Achieving Completeness in Technical Communication
Once you've finished writing a technical document, you need to make sure that the information is usable and accurate. This video provides tips on how to make your documents textually and visually complete.
8. Ensuring that Technical Documents Are Easily Understood
In order for our audience to comprehend and act on the information we write, they have to be able to clearly understand what our document says. This video provides tips on how to ensure that our technical documents can be easily understood.
9. Sequence in Technical Documents
Arranging your information in a particular order will help emphasize the points you want to make in technical documents. This video provides tips for creating a clear sequence in technical writing.
10. Organization in Technical Documents
In order for our readers to understand what we are trying to communicate, we must effectively organize our information. This video provides tips on how to organize writing for technical documents.
11. Achieving Unity in Technical Writing
Keeping a document focused on one subject will help improve your audience's ability to comprehend your message. This video contains strategies to help keep your document unified.
12. The Importance of Message Follow-Up
Business communications depends on excellent writing and good message follow-up. In order to get a response for feedback, comments, information or purchase orders there are some suggestions to follow to have a successful result.
13. Using Technology to Help Compose Your Message: Formatting & Effectiveness
An important skill for individuals to develop for the work place is the ability to use technology to compose messages. Word processing software can help improve formatting and the overall effectiveness of your message.
14. Giving and Responding to Constructive Feedback
Giving and receiving feedback in a work environment allows individuals to understand how they are performing in their job. There are suggestions that individuals can follow to better understand how to deal with criticism.
Earning College Credit
Did you know… We have over 200 college courses that prepare you to earn credit by exam that is accepted by over 1,500 colleges and universities. You can test out of the first two years of college and save thousands off your degree. Anyone can earn credit-by-exam regardless of age or education level.
To learn more, visit our Earning Credit Page
Transferring credit to the school of your choice
Not sure what college you want to attend yet? Study.com has thousands of articles about every imaginable degree, area of study and career path that can help you find the school that's right for you.
Other chapters within the English 305: Advanced Technical Writing course
- Basics of Technical Writing
- Prewriting for Technical Documents
- Writing Technical Documents
- Elements of Technical Documents
- Usability Testing & Technical Writing
- Informal Technical Reports
- Formal Technical Reports
- Business Reports and Proposals
- Technical Correspondence
- Technical Writing in Business Correspondence
- Technical Resumes & Cover Letters
- Technical Instructions
- Writing Technical Manuals
- How to Write Proposals
- Required Assignments for English 305
- Studying for English 305