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.
As a side effect of switching to AuthorIT we 'gained' these and they went
down a storm. Particularly in the midst of long developer guides.
You know what they say, you can never have too many navigation methods.
That and "know your users" of course ;-)
Is it Friday yet?
Gordon
-----Original Message-----
From: techwr-l-bounces+gordon -dot- mclean=grahamtechnology -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+gordon -dot- mclean=grahamtechnology -dot- com -at- lists -dot- techwr-l -dot- c
om] On Behalf Of Nancy Allison
Sent: 20 April 2007 15:48
To: TECHWR-L -at- lists -dot- techwr-l -dot- com
Subject: Internal Chapter TOCs
Hi, everyone.
I'm working on an installation manual that contains many small procedures.
I've grouped these procedures where it made logical sense to do so, but
there are still many of them. As a result, each chapter ends up with a lot
of level 1 headings.
For the rest of the documentation set for this product, I've started each
chapter with a 1- or 2-sentence summary of the scope, and then said, "This
chapter contains the following sections" and provided a bulleted list of the
level 1 headings. Most chapters have had 4 to 6 headings, so the list has
been a succinct way to provide a clearer picture of the chapter's scope.
But the chapters in this doc contain many, many small procedures, even after
they've been grouped logically. The bulleted lists can contain 10 or 12
entries. It does not make sense to chop the chapters in half, either, just
so that each new chapter can contain 5 or 6 bulleted list items. (Many of
the chapters are dedicated to installing the product on a particular
e-commerce platform. One chapter per platform. Works well, except for this
silly problem.)
I'm thinking I could go either way:
1. Eliminate the list. It's too long to be useful. Or, 2. Create a real
internal TOC, with page numbers and leader dots. Since this is the most
technical guide of the doc set, it makes sense that it would be formatted in
a more formal way.
I'm leaning toward #2. I do think that these internal lists at the start of
a chapter contribute something useful . . . but I'm willing to be persuaded
otherwise, or bowled over by a solution I haven't even considered.
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
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor, full
Unicode support. Create help files, web-based help and PDF in up to 106
languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as
Gordon -dot- McLean -at- grahamtechnology -dot- com -dot-
To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/ for more resources and info.
--
No virus found in this incoming message.
Checked by AVG Free Edition.
Version: 7.5.446 / Virus Database: 269.5.5/769 - Release Date: 19/04/2007
17:56
--
No virus found in this outgoing message.
Checked by AVG Free Edition.
Version: 7.5.446 / Virus Database: 269.5.5/769 - Release Date: 19/04/2007
17:56
____________________________________________________________________________________________________
This email (and any attachments) is private and confidential, and is intended solely for the
addressee. If you have received this communication in error please remove it and inform us via
telephone or email. Although we take all possible steps to ensure mail and attachments
are free from malicious content, malware and viruses, we cannot accept any responsibility
whatsoever for any changes to content outwith our administrative bounds. The views represented
within this mail are solely the view of the author and do not reflect the views of the organisation
as a whole.
____________________________________________________________________________________________________
Graham Technology plc
Registered in Scotland company no. SC143434
Registered Office India of Inchinnan, Renfrewshire, Scotland PA4 9LH
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
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
