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:XML tag usage question From:siliconwriter -at- comcast -dot- net To:techwr-l -at- lists -dot- techwr-l -dot- com (Tech Whirlers) Date:Tue, 04 Apr 2006 19:40:58 +0000
The head of software development at my client's company is an excellent writer. He recently wrote drafts of three articles about XML tagging, which will be finalized by me and distributed to customers. Here is the problem:
In defining an XML tag, you usually use the word "attribute" to describe a defined field within an element. My guy is using the word "prop", short for property. I believe that readers familiar with XML (which will be many of them) might be confused by our renaming of a familiar term. However, if I change "prop" to "attribute" throughout the paper, I must do so in every other paper written by the software department, and that's a lot of papers.
Should I change the word "prop" to "attribute" throughout the documents, or should I go ahead and accept this unfamiliar usage, possibly with a "disclaimer" or "definition" at the start of each chapter? The first benefits my readers, the second my client. Any thoughts?
Sarah
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l