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:RE: XML as Help Format From:"Lydia Wong" <lydiaw -at- fpoint -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 18 Oct 2001 10:42:00 -0400
Robert Johnson wrote:
<snip>
We have spawned a new sister company, which is currently only a development
organization. We provide marketing, tech support, and, of course,
documentation, for them.
The developers in this company want to use XML as theHelp format.
</snip>
Robert, are your developers working in the new MS development language C#?
That language includes a way to integrate provided and user-defined XML tags
in the source code itself. There is a command then to pull out the XML
portions to create the documentation. It's a neat idea, but it's certainly
not a complete documentation package. Once you get that XML out of the
source, you've got to do something with it!
You might want to ask them more about what they had in mind and why XML. If
they are in fact using C# and want to imbed XML tags with documentation
info. in the source, you'll need to work with them very closely to plan how
that will fit into your documentation set. If they aren't doing this, why
the push for XML?
HTH,
Lydia
---------------
Lydia Wong
Technical Writer
FarPoint Technologies, Inc.
www.fpoint.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Announcing new options for IPCC 01, October 24-27 in Santa Fe,
New Mexico: attend the entire event or select a single day.
For details and online registration, visit http://ieeepcs.org/2001
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
