{"id":3988,"date":"2013-08-30T11:26:42","date_gmt":"2013-08-30T16:26:42","guid":{"rendered":"http:\/\/www.encoretechresources.com\/insights\/?p=3988"},"modified":"2013-08-31T19:06:06","modified_gmt":"2013-09-01T00:06:06","slug":"subheads-for-clarity-if-not-beauty","status":"publish","type":"post","link":"http:\/\/www.encoretechresources.com\/insights\/2013\/08\/30\/subheads-for-clarity-if-not-beauty\/","title":{"rendered":"Subheads for Clarity, If not Beauty"},"content":{"rendered":"<p>Technical writing needs to be orderly, but to insure that it&#8217;s read and understood by busy people, it definitely shouldn&#8217;t be dense. Aside from writing reasonably short, orderly sentences, adding subheads when the focus changes a bit is a mechanical, but very helpful, way of keeping a reader with you. Subheads are perhaps a tech writer&#8217;s most valuable organizational tool.<\/p>\n<p><a href=\"http:\/\/www.encoretechresources.com\/insights\/wp-content\/uploads\/images1.jpg\"><img loading=\"lazy\" decoding=\"async\" class=\"alignleft size-medium wp-image-3989\" alt=\"images\" src=\"http:\/\/www.encoretechresources.com\/insights\/wp-content\/uploads\/images1-300x111.jpg\" width=\"300\" height=\"111\" srcset=\"http:\/\/www.encoretechresources.com\/insights\/wp-content\/uploads\/images1-300x111.jpg 300w, http:\/\/www.encoretechresources.com\/insights\/wp-content\/uploads\/images1.jpg 368w\" sizes=\"(max-width: 300px) 100vw, 300px\" \/><\/a>Tom Johnson, on his excellent &#8220;I&#8217;d Rather Be Writing&#8221; technical writing blog,<a href=\"http:\/\/idratherbewriting.com\/2013\/08\/23\/subheadings-perhaps-the-most-useful-technique-in-technical-writing\/\"> deals with the virtues of subheads<\/a> at some depth. Tom took a poll on why &#8220;users can&#8217;t find answers in help material.&#8221; \u00a0And he found that &#8220;help is either too long so users can&#8217;t find the answer, or help is too short so users can&#8217;t find the answer.&#8221; So what&#8217;s needed is a mechanism to facilitate organizing and scanning a page. (Oh, there&#8217;s that &#8220;f&#8221; word again.) Subheads are the answer both to orderly writing and orderly page layout.<\/p>\n<p>Use subheads, first, to organize material that belongs together and then to draw your reader&#8217;s eyes to your handiwork. You&#8217;ve made his or her day when it&#8217;s easy to follow what you&#8217;re presenting. Subheads along with reasonably clear writing are the answer. \u00a0They&#8217;re both attractive \u00a0typographically and \u00a0highly utilitarian. (Below a subhead, or instead of one, a &#8220;bullet&#8221; dot to set off key sentences or paragraphs can also be helpful.)<\/p>\n<p>A maximum of four indented subheads on a page, as illustrated here, may actually be too many, unless your material is so complex that it requires them. Definitely avoid run-on subheads, as much as run-on writing. The idea is to be organized, not typographically lush.\u00a0Typographical techniques aren&#8217;t a substitute for clear, well-organized writing, just helpmates in negotiating your terrain. The eye can be distracted by too many of them.<\/p>\n<p>&#8220;Almost any Wikipedia page provides a great example of subheadings in action,&#8221; Tom notes. &#8220;There we have many paragraphs of content broken up by subheadings, with a built-in navigation embedded at the top. It\u2019s a model that seems to work well on the web.&#8221; Subheads work well on paper, too, if they&#8217;re not overdone. Keep them always in mind as your technical writing unfolds. \u2013 <em>Doug Bedell\u00a0<\/em><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Technical writing needs to be orderly, but to insure that it&#8217;s read and understood by busy people, it definitely shouldn&#8217;t be dense. Aside from writing reasonably short, orderly sentences, adding subheads when the focus changes a bit is a mechanical, but very helpful, way of keeping a reader with you. Subheads are perhaps a tech [&hellip;]<\/p>\n","protected":false},"author":7,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[8,3,5],"tags":[],"class_list":["post-3988","post","type-post","status-publish","format-standard","hentry","category-communication","category-technology","category-the-writing-life"],"aioseo_notices":[],"_links":{"self":[{"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/posts\/3988"}],"collection":[{"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/users\/7"}],"replies":[{"embeddable":true,"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/comments?post=3988"}],"version-history":[{"count":6,"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/posts\/3988\/revisions"}],"predecessor-version":[{"id":3995,"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/posts\/3988\/revisions\/3995"}],"wp:attachment":[{"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/media?parent=3988"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/categories?post=3988"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/tags?post=3988"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}