As a member, you'll also get unlimited access to over 79,000 lessons in math, English, science, history, and more. Plus, get practice tests, quizzes, and personalized coaching to help you succeed.
Try it risk-freeAlready registered? Log in here for access
Suzanne has taught 12 years in the NC Public School System and three years at Campbell University. She has a master's degree in English Education.
For Christmas one year, we bought our son a Lego set. The box contained over 700 pieces and had an instruction booklet with step-by-step directions and graphics. My son followed the directions and was halfway through the construction of an airplane when he realized that his instruction booklet was missing a page. He could not complete the assembly because there were no directions or visuals to guide him. We called the company, and they sent us a new booklet, but by then, my son had lost interest in the set because of his initial disappointment.
People expect that when they purchase a product, read a research paper, or receive an email, that the document will be complete. Missing information doesn't just cause frustration, like with my son; in the business world, missing information can cause a loss of time and money. To ensure that you achieve completeness in your technical writing, it is important to examine both the text and the visual components of your document.
In this lesson, we will look at how to achieve textual and visual completeness.
Have you ever tried to give someone instructions on how to do something that seems so easy to you but the other person just doesn't understand your directions? The first time I asked my son to vacuum his room and gave him instructions on how to use the vacuum, I thought the task would be an easy one. Thirty minutes later, he still hadn't figured out how to turn the vacuum on.
Sometimes, what we consider to be obvious isn't so apparent to someone else. That's why it's important in technical writing to make sure that you provide enough detail in your document that the document is self-explanatory. Textually complete documents provide the audience with the exact amount of information they need to complete a task or understand a topic.
To ensure textual completeness, writers should:
Once you've finished writing the document, you should always proofread the document yourself to catch any grammatical mistakes. However, it is equally as important to have someone else proofread the document, especially if the document explains a process. Another reader can more easily determine if you've accidentally left a step out that seemed obvious to you. They can also check to see if you have provided enough details without overwhelming the reader with too much information.
Next, check the usability of the document. When examining usability, ask yourself these questions:
Finally, know your intended audience. By understanding who will likely read the document, you can evaluate whether the document has met the needs of the audience. Will the audience be able to understand the language you've used? Will the audience understand the purpose of the document? Have you made it clear what you want the audience to do as a result of reading the information? By understanding your audience, you are able to anticipate and answer any potential questions there might be about the document.
My daughter recently tried to put together a gingerbread house. Unfortunately, the directions she received had a picture of a house that was different from the pieces she received in the box. Since all of the drawings went with the pieces that weren't included in our box, my daughter could not figure out how to put the house together, despite having written directions. We ended up just eating the pieces!
Sometimes, words are not enough to provide understanding. Most people in today's society are visual learners. They need to see how something works, not just read about it. This means technical writers need to go beyond just looking at the text of a document. They must evaluate how the document looks visually to determine if it is complete. To achieve visual completeness, ensure that you've included graphics and tables when necessary and that you've provided visual cues for easy reading.
If you had to create a document explaining how to use a camera, would it be enough just to write directions? If you referenced the shutter release or the aperture, would the general public understand what you were talking about? Probably not. When words are not sufficient enough to convey an idea, a graphic can help communicate an idea by allowing the audience to see what they're reading about, so they can more easily apply the knowledge.
If a document includes values, measurements, and other data, consider creating a table, chart, or graph to help the reader better understand how the data relate to one another. For example, if you are comparing how many people voted in an election based on the income of those people, putting the data in a bar graph allows the reader to quickly see trends in the data.
Finally, when looking over your finished document, make sure that you have provided visual cues for your reader. Today's audience wants to be able to scan over a document, quickly determine what the document will address, and find specific information in the text, which is hard to do when the information provided does not include visual cues.
Consider adding some of the following visual cues to break a document into smaller, easier to comprehend chunks:
Achieving completeness in technical documents goes beyond just finishing the writing. Achieving completeness involves making sure that the text is usable and accurate, and that important information can be quickly found and understood.
To ensure textual completeness, writers should:
Additionally, to ensure visual completeness, writers should add graphics, tables, and graphs to help explain complex information, and use headlines, bullet points, and other visual cues to help break the information into smaller chunks.
Once you've completed this lesson, you should be able to:
To unlock this lesson you must be a Study.com Member.
Create your account
Already a member? Log In
BackAlready registered? Log in here for access
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
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.
Back To Course
English 305: Advanced Technical Writing17 chapters | 131 lessons | 11 flashcard sets
{{courseNav.course.topics.length}} chapters | {{courseNav.course.mDynamicIntFields.lessonCount}} lessons | {{course.flashcardSetCount}} flashcard set{{course.flashcardSetCoun > 1 ? 's' : ''}}
Next Lesson
Watch 5 minute video clips, get step by step explanations, take practice quizzes and tests to master any topic.
Study.com has a library of 750,000 questions and answers for covering your toughest textbook problems
I love the way expert tutors clearly explains the answers to my homework questions. Keep up the good work!
- Maritess, College StudentStudy.com video lessons have helped over 30 million students.
"I learned more in 10 minutes than 1 month of chemistry classes"
- Ashlee P.
"I learned more in 10 minutes than 1 month of chemistry classes"
- Ashlee P.
"I aced the CLEP exam and earned 3 college credits!"
- Clair S.
Over 65 million users have prepared for {{displayNameByProductKey[registrationData.product || testPrepCocoon]}} and other exams on Study.com
"The videos have changed the way I teach! The videos on Study.com accomplish in 5 minutes what would take me an entire class."
- Chris F.
Over 65 million users have prepared for {{displayNameByProductKey[registrationData.product || testPrepCocoon]}} and other exams on Study.com
