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: 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.
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-