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.
The product my company produces uses XML. In the process of developing the
initial technical document for the product, the team as a whole got somewhat
bogged down over the question of the "correct" way to document the XML. We
managed to muddle our way through and found a solution that (mostly)
satisfied the developers.
Now that I am writing the style guide, I hope to include standards for
documenting the XML so that we do not re-visit the topic on the next
project. Does anyone know of or use a "standard" approach to documenting XML
that has support throughout the industry? Short of that, is anyone aware of
a template that works well?
Please feel free to contact me directly. If there is interest, I will
summarize for the list.
TIA!
Sheldon S. Kohn
Senior Technical Writer
Online Insight, Inc.
