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.
RE: organizing DTD <element> and interface information
Subject:RE: organizing DTD <element> and interface information From:"Lisa Wright" <liwright -at- earthlink -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 30 Jun 2003 08:42:13 -0700
You're right Jan. I didn't include all those qualifying "I are a tek
riter" clauses that explain that I know how to be one (including doing
an audience analysis)! Silly me. OTOH, maybe I didn't ask the question
very well. *That's* certainly happened before! :-)
Thanks for the suggestion...it falls in line with what I was thinking.
As always, it comes down to making the information accessible,
regardless of how the reader is looking for it.
Lisa
-----Original Message-----
From: bounce-techwr-l-53104 -at- lists -dot- raycomm -dot- com
[mailto:bounce-techwr-l-53104 -at- lists -dot- raycomm -dot- com] On Behalf Of Jan
Henning
Sent: Sunday, June 29, 2003 10:28 PM
To: TECHWR-L
Subject: Re: organizing DTD <element> and interface information
Hi Lisa
> Seriously, I may be in a position to contact the customer and/or find
> another way to get the information at some point. But for now, I
> can't.
Sorry that I misunderstood you - if you mentioned this problem, I must
have overlooked it.
Since you don't know why you are doing this, why not take an
incremental approach: Add the element names to the screen descriptions,
using a special paragraph tag. Add any additional notes that may apply
using one of your standard tags.
Then create an alphabetical list of these paragraphs, which gives the
customer a way from XML to screen without any additional work for you.
ANNOUNCING ROBOHELP STUDIO
Create professional Help systems that feature interactive tutorials and
demos with all new RoboHelp Studio. More at http://www.ehelp.com/techwr-l2
Mercer University's online MS Program in Technical Communication Management:
Preparing leaders of tomorrow's technical communication organizations today.
See www.mercer.edu/mstco or write George Hayhoe at hayhoe_g -at- mercer -dot- edu -dot-
---
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.
