RE: Best practice for technical documentation page length on awebsite?

Subject: RE: Best practice for technical documentation page length on awebsite?
From: "Jessica Weissman" <Jessica -dot- Weissman -at- hillcrestlabs -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 30 Jul 2007 08:46:04 -0400

We present the documentation (for an API) in two formats, PDF with
ordered numbered sections and subsections that can be skimmed easily,
and a searchable electronic book with topics presented in a window. I
format the electronic book so that introductory topics have links to the
subsidiary topics where that makes sense.

Not much complaint so far. We'll see if external developers are as
content with it as internals are.

- Jessica
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.


References:
Best practice for technical documentation page length on a website?: From: procrastiwriter
Re: Best practice for technical documentation page length on a website?: From: Sandy Harris

Previous by Author: RE: Unusual user
Next by Author: RE: Tech writers still necessary, but performing poorly
Previous by Thread: Re: Best practice for technical documentation page length on a website?
Next by Thread: Responses to multiple posts


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


Sponsored Ads