Re: Best practice for technical documentation page length on a website?

["Sandy Harris" <sandyinchina -at- gmail -dot- com>]

On 7/26/07, procrastiwriter <procrastiwriter -at- googlemail -dot- com> wrote:

> Within the original CHM files, the tendency was to have a fairly 'deep'
> table of contents and often lots of relatively short pages within each
> section. This same structure was transferred to the website.
>
> Understandably, some people are complaining that it takes too long to drill
> down and find information, and I agree that many of the sections could be
> combined into a single page  ...

Text, including HTML, is malleable. Can you give users both formats?
Would it be easy to automate that?

One thing we provided for one project I wrote for was "All our docs as
one big file". Some users preferred that for easy searching. It was a
few hundred K, OK on a fast connection. I forget how we automated
building that. Link here:
http://www.freeswan.org/freeswan_trees/freeswan-2.06/doc/index.html

-- 
Sandy Harris
Quanzhou, Fujian, China
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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- 

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.