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.
Subject:Word to the wise From:"John Posada" <jposada99 -at- gmail -dot- com> To:TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 26 Feb 2008 10:41:06 -0500
Word to the wise, hoping that others will learn from my error.
It was just pointed out to me that 50% of the 100+ context sensitive topics
for my online help don't work in the GA release of my most recent project.
We use an xml file with the mapID targets and URLs in place of a .h file. It
seems that between the last version that was checked, and the version that
got written to the CD, an ending quotation mark was missing half way
through. This resulted in every line after that falling into the non-valid
XML camp.
I'm not sure how we're going to fix this. However, had I been using the
right application to write in (opposed to Notepad) or a validator
afterwards, the error would have been apparent within seconds.
What did I learn? Don't cut corners and use the right tools.
John Posada
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-