TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
RE: Numbered versus unnumbered heads in very technical reference guides
Subject:RE: Numbered versus unnumbered heads in very technical reference guides From:"Porrello, Leonard" <lporrello -at- illumina -dot- com> To:Matt Gras <mattgras -at- comcast -dot- net>, tech2wr-l <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 17 Jun 2013 20:45:52 +0000
Before you could formulate an argument, you'd have to answer at least the following questions:
Online Help, online PDF, or printed book?
How do/would the numbers help the user?
Is there any way in which the numbers detract from the user experience?
Is there another, less intimidating way to do what the numbers do (granted that they do confer some benefit)?
Are the numbers required by contract?
From: techwr-l-bounces+lporrello=illumina -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+lporrello=illumina -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Matt Gras
Sent: Monday, June 17, 2013 1:38 PM
Subject: Numbered versus unnumbered heads in very technical reference guides
I'm seeking to present arguments for and against using numbered heads in reference guides (and related documentation). The material is very dense and very technical, and the audience includes both experienced and inexperienced users.
Your thoughts are very much appreciated.
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.