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: How many levels of indents and heads are reasonable?
Subject:Re: How many levels of indents and heads are reasonable? From:John Posada <jposada01 -at- yahoo -dot- com> To:Richard Lewis <tech44writer -at- yahoo -dot- com>, Bill Swallow <techcommdood -at- gmail -dot- com> Date:Thu, 11 Oct 2007 13:32:15 -0700 (PDT)
Sure...that happens too. My "tip off" that I'm heading in that direction with what I write is when I notice a section with more than half a page of body text or more than a whole page of steps without a subheading. There may be a legit reason for that to happen. However, it focuses my attention to meka sure it wouldn't be better with subheadings.
John Posada
Senior Technical Writer
"They say everyone needs goals. Mine is to live forever.
So far, so good."
----- Original Message ----
From: Richard Lewis <tech44writer -at- yahoo -dot- com>
To: Bill Swallow <techcommdood -at- gmail -dot- com>
Cc: techwr-l List <techwr-l -at- lists -dot- techwr-l -dot- com>
Sent: Thursday, October 11, 2007 12:15:47 PM
Subject: Re: How many levels of indents and heads are reasonable?
And, conversely, I have seen larger systems documented with not enough heading levels. In such situations, there are often "big hunker" sections that really need to be partitioned into sub-sections.
The real question is how does one partition a system into right size chunks of info (hint, evaluate the interface complexity). Then, if you have, for example, 500 right size chunks, you can either create one doc to maybe seven levels of headings, or three docs each to maybe three levels of heading.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
