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.
Ohh and one final thing. If your help is largely task focussed - from
reading between the lines I think it may be - another standard you should
investigate is DITA.
It may match your needs a little better, it may not.
Do let us know what solution you choose though.
Gordon
-----Original Message-----
From: techwr-l-bounces+gordon -dot- mclean=grahamtechnology -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+gordon -dot- mclean=grahamtechnology -dot- com -at- lists -dot- techwr-l -dot- c
om] On Behalf Of Hickling, Lisa (TOR)
Sent: 23 August 2007 19:42
To: rick -at- rlcdata -dot- com; techwr-l
Subject: RE: DocBooks question
Hello Rick,
Welcome! Hmmm...do I sense some underlying developer cum writer angst in the
issues you have raised? If so, I empathize having been there and formerly
worn the t-shirt. Helpful tip: keep an open mind when asking for help on
this list. The responses so far have pointed you to a possibility that
Docbook is the least of your worries at this point.
You have striven to be innovative and created your own help tool.
Honestly, this is very good but potentially a bad thing. While you have a
completely custom help application, now you have the challenge of
retrofitting it for indexing and searching capabilities. This is, in effect,
an exercise in wheel reinvention given the abundant availability of HATs, as
someone already pointed out. Possible solution: Use the hat-matrix.com site
to select the HAT that best suits your requirements (including DocBook
support) and budget, upload your html pages to it, build your index and
depend on the tool's capabilities to deliver your search.
Regarding DocBook, it is admirable that you want your content to adhere to
an establish standard from the outset. Consider familiarizing yourself with
its tenets and applying its standards to elements of your docs as part of
your style guide. Your docset will then be well equipped for integration
into a XML solution when your other issues are solved and implementation is
appropriate.
Best wishes on your project!
Lisa H.
GTA, Ontario
******* Confidentiality Notice *******
ESI Canada -- Optimizing the value of drug and dental benefits
This email, its electronic document attachments, and the contents of its
website linkages may contain confidential health information. This
information is intended solely for use by the individual or entity to whom
it is addressed. If you have received this information in error, please
notify the sender immediately and arrange for the prompt destruction of the
material and any accompanying attachments.
******* Avis de confidentialite *******
ESI Canada -- Optimiser la valeur des regimes d'assurance medicaments et
dentaires
Ce courriel ainsi que tout document y etant joint de meme que le contenu des
liens vers des sites Web peuvent reunir des renseignements confidentiels
sur la sante. Cette information s'adresse uniquement a l'usager ou a
l'organisation auxquels elle est destinee. Si vous avez recu ce message par
erreur, veuillez en aviser l'expediteur immediatement et proceder a la
suppression du document et des fichiers joints sans tarder.
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
Gordon -dot- McLean -at- grahamtechnology -dot- com -dot-
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.
____________________________________________________________________________________________________
This email (and any attachments) is private and confidential, and is intended solely for the
addressee. If you have received this communication in error please remove it and inform us via
telephone or email. Although we take all possible steps to ensure mail and attachments
are free from malicious content, malware and viruses, we cannot accept any responsibility
whatsoever for any changes to content outwith our administrative bounds. The views represented
within this mail are solely the view of the author and do not reflect the views of the organisation
as a whole.
____________________________________________________________________________________________________
Graham Technology plc
Registered in Scotland company no. SC143434
Registered Office India of Inchinnan, Renfrewshire, Scotland PA4 9LH
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-
