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: A method to organize information? From:Paula Cristina Vaz <paula -dot- vaz -at- altitude -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 9 Nov 2001 13:11:55 -0000
Hello again,
First of all, thank you for your kind answers and I'm sorry for the late
response. They didn't show me the way but made me think. :)
Susan: we are already outlining and doing task analysis. We use a XML editor
specially adapted to our documentation and with features oriented to our
needs. We have a programmer working on the editor programming. Thanks for
hint on the sites.
Thanks for the idea of the STC reviewers and the competition. I'll try that
one.
Geoff: thanks for you explanation of the structure of a document. That helps
and I'll keep that in mind when I'll write.
One of our major problems with document testing is the difficult we have to
reach the users. We do internal reviews, but we can not define a type of
users. We also don't know some of the users and what their needs are.
Dick: you are right I'm more "technical" then "writer". And I guess I'm
looking for a standard way to write documents and reaching the conclusion
that technical writing is a more creative and subjective job.
The other problem we have is that we have a product constantly changing
philosophies and we can not, for example, do standard set up documents,
because the strategy for the setting up changes between versions. So if we
do task analysis, for example, the tasks you need to do for the first
version are different from the tasks we need to do for the second version.
In this case, all the document has to be restructured.
Best regards,
Paula
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Be a published author! iUniverse gives you: a high-quality paperback, a
custom cover design, and distribution to 25,00 retailers. Join our almost
10,000 published authors today. http://www.iuniverse.com/media/techwr
---
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.