Re: Nested bullets - how many levels deep do you go?

Subject: Re: Nested bullets - how many levels deep do you go?
From: Peter Neilson <neilson -at- windstream -dot- net>
To: techwr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 13 Feb 2009 12:45:36 -0500

Gene is correct. One level of bullets is enough. Beyond that, you have
created something that you (and your reviewers) feel you can understand,
but that is generally inappropriate for your audience. Nested
information requires the reader to keep a mental push-down list, or to
re-traverse your list with his finger. ("What ARE we talking about
here??? Oh. And that is part of ... ?? Oh. Sheesh.")

If it's a tutorial, the bullets only belong in an overview section.

All too often they give a document the appearance of being neat and
organized, when it's really just a mess pasted onto a structure.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals.
http://www.doctohelp.com

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
Nested bullets - how many levels deep do you go?: From: Downing, David
Re: Nested bullets - how many levels deep do you go?: From: Gene Kim-Eng

Previous by Author: Re: Should software documenters learn to read code?
Next by Author: Re: Studies relating to documentation density and getting the user to read the manuals
Previous by Thread: RE: Nested bullets - how many levels deep do you go?
Next by Thread: Nested bullets - how many levels deep do you go?


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads