RE: How do you publish your documents, guides or completed help

Subject: RE: How do you publish your documents, guides or completed help
From: "Jessica Weissman" <Jessica -dot- Weissman -at- hillcrestlabs -dot- com>
To: "Daniel Ng" <kjng -at- gprotechnologies -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 19 Jun 2007 08:07:43 -0400

I keep a documentation list on our Wiki. When any document gets
updated, it is published automatically to the directory that is the
source of the links on the Wiki page, under the "current version"
filenames. People who use the copies in the directory automatically
have the right version. Our doc comes in three formats: ebook, PDF
optimized for the screen, and PDF optimized for searching.

If there is a significant change (enough to bump the minor version
number) I update the Wiki page in a way that is visible - the link that
carries version numbers in the file title changes. This triggers a
notification to the people who really care. Others who enter the Wiki
see the page listed as having an update. They can go look.

Major changes trigger changes in the major version number. These rate
an email to the right user list. Developers and others can then go
check the Wiki or download the new version.

Not perfect, but it works for us so far. When we get external clients
for our SDK (soon!) we will have a distribution method for them as well.
The product managers are working that one out.

Jessica Weissman
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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:
How do you publish your documents, guides or completed help: From: Daniel Ng

Previous by Author: Job outlook...
Next by Author: a word of warning
Previous by Thread: How do you publish your documents, guides or completed help
Next by Thread: RE: How do you publish your documents, guides or completed help


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


Sponsored Ads