“Stalling” the reader is bad. Skip over the next heading to learn what this is all about.
Important information
Disclaimer: This material is subject to change without notice. Except as may be explicitly set forth by written agreement, no representation or warrantee is made regarding the completeness, accuracy, or usefulness of this information.
Copyright: This material may be protected by copyright. All rights reserved. All other copyrighted material is the property of their respective owners.
References and other resources: “Elements of Style”, Strunk & White; “On Writing”, Steven King; “Techniques for Technical Communicators”, Barnum & Carliner.
Installation, compatibility, and system requirements: No special installation required. This document should be compatible with all programs that support ASCII text display. Systems supported include all Linux and x86-compatible hardware.
Keyboard shortcuts and other tips: The user may scroll through this document using the keyboard Up and Down keys. Full pages may be viewed with the Page-up and Page-down keys. See a full list of keyboard bind keys for all other applications.
Help and support: A list of sales and support offices for your area can be found on our web site. Customers with service agreements may contact our 24-hour hot line. Customers without such agreements must contact their local sales office for support.
Related material: See “Ron's Writing & Communicating Tips”, numbers 1 thru 12.
What's this all about? When someone picks up material based on its title, they expect it to address the topic as soon as possible. Anything that stands between the title and the part that speaks to it has the effect of “stalling” the reader. (If you read the section before this, you just experienced that effect.)
(Source: Grey Flannel Graphics)
Stalling the reader is bad for several reasons. First, it inflates the material unnecessarily, making it appear longer — and more daunting — than it really is. Second, it dilutes the reader's focus, potentially taking them off-topic and reducing their momentum. Worse still, it forces the reader to determine for themselves where the piece actually begins, thereby making the material feel disorganized. (Actually, stalling the reader is a sign of poor organization.)
Click Here to see an example manual that adheres to the “Don’t stall the reader” concept. Have you ever read a manual that left you feeling “stalled”? How important is this “Don’t stall the reader” concept to you? And how would you organize such a manual?
There are many well-intentioned reasons for stalling the reader (see Important information above) but they are all doomed to fail. Writers often insert material to “force” that portion to be read first, but this is quickly circumvented. (Do you know anyone who skips to the end of the book to see what happens? I thought so.)
Ultimately, you can't force the reader to do anything. In particular, readers of technical material are largely task-driven and are looking to gain specific information. These are people who are on a mission, and the best you can do is help them. So, get to the point as quickly as you can; organize your material to speed them on their way; and don't stall the reader!
“The driver for a lot of this stuff now a days is regulatory requirements. Many safety standards mandate specific sections in the user manual (even if there is nothing to put in that section other than “this product requires no cleaning or maintenance”)
We use cookies on our website to give you the most relevant experience by remembering your preferences and repeat visits. By clicking “Accept All”, you consent to the use of ALL the cookies. However, you may visit "Cookie Settings" to provide a controlled consent.
This website uses cookies to improve your experience while you navigate through the website. Out of these, the cookies that are categorized as necessary are stored on your browser as they are essential for the working of basic functionalities of the website. We also use third-party cookies that help us analyze and understand how you use this website. These cookies will be stored in your browser only with your consent. You also have the option to opt-out of these cookies. But opting out of some of these cookies may affect your browsing experience.
Necessary cookies are absolutely essential for the website to function properly. These cookies ensure basic functionalities and security features of the website, anonymously.
Cookie
Duration
Description
cookielawinfo-checkbox-analytics
11 months
This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Analytics".
cookielawinfo-checkbox-functional
11 months
The cookie is set by GDPR cookie consent to record the user consent for the cookies in the category "Functional".
cookielawinfo-checkbox-necessary
11 months
This cookie is set by GDPR Cookie Consent plugin. The cookies is used to store the user consent for the cookies in the category "Necessary".
cookielawinfo-checkbox-others
11 months
This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Other.
cookielawinfo-checkbox-performance
11 months
This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Performance".
viewed_cookie_policy
11 months
The cookie is set by the GDPR Cookie Consent plugin and is used to store whether or not user has consented to the use of cookies. It does not store any personal data.
Functional cookies help to perform certain functionalities like sharing the content of the website on social media platforms, collect feedbacks, and other third-party features.
Performance cookies are used to understand and analyze the key performance indexes of the website which helps in delivering a better user experience for the visitors.
Analytical cookies are used to understand how visitors interact with the website. These cookies help provide information on metrics the number of visitors, bounce rate, traffic source, etc.
Advertisement cookies are used to provide visitors with relevant ads and marketing campaigns. These cookies track visitors across websites and collect information to provide customized ads.
You must verify your email address before signing in. Check your email for your verification email, or enter your email address in the form below to resend the email.
Please confirm the information below before signing in.
{* #socialRegistrationForm *}
{* firstName *}
{* lastName *}
{* displayName *}
{* emailAddress *}
By clicking "Sign In", you confirm that you accept our terms of service and have read and understand privacy policy.
{* /socialRegistrationForm *}
Almost Done
Please confirm the information below before signing in. Already have an account? Sign In.
“I'm afraid I'm bad at this because I always want to start off by “setting the scene” (said Max, sadly)”
“Well Max, I wasn't going to say anything (said Ron, with a mild chuckle.)”
“The driver for a lot of this stuff now a days is regulatory requirements. Many safety standards mandate specific sections in the user manual (even if there is nothing to put in that section other than “this product requires no cleaning or maintenance”)