Re: Documentation Deliverables for Complex Scenario

Subject: Re: Documentation Deliverables for Complex Scenario
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 1 Jul 2009 13:43:14 -0700

It's a lot easier to be able to look up whatever you want wherever you
happen to be than to have to start some other component first, so I'd
integrate all the help content into one big "book," making sure the
outline / TOC was easy to navigate.

In some cases this may mean delivering the same big package in several
formats. E.g. I had a complex product where a Windows client got a
.chm, an Eclipse client got Eclipse help, and a server component with
no UI got a PDF--but all three had all the information.

I'd organize the help by workflow lifecycle.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices.
http://www.doctohelp.com/SuperPages/Webcasts/

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:
Documentation Deliverables for Complex Scenario: From: Deborah Hemstreet

Previous by Author: Re: Edit PDF in Acrobat Pro?
Next by Author: Re: Edit PDF in Acrobat Pro?
Previous by Thread: Documentation Deliverables for Complex Scenario
Next by Thread: Re: Documentation Deliverables for Complex Scenario


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

Sponsored Ads


Sponsored Ads