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.
I'm two for two on receiving choice and alternative solutions.
With this kind of success, I'd like to make it three for three.
Situation:
* An computer application has been developed and needs to be
documented. Documentation was an afterthought.
* I do not have access to the application. It is live, meaning
it is currently in use.
* One person has been assigned to be my resource person. This
person knows who uses the application, what they use it for and
can give me step-by-step procedures for the tasks.
* We have had several meetings that helped me produce an
information plan. The plan includes the scope of the project and
my suggestions on presentation for the manual, etc.
* The resource person's supervisor thinks we have already spent
too much time discussing things (approx. 5 hours) and wants to
see the documentation.
Need advice on:
* Does anybody have a strategy for quickly and efficiently
getting information and writing the procedures that go in the
documentation?
Currently I lurk over the shoulder of the resource person, watch
as they move through how a task is done, write a rough draft of
the procedures. I also ask for screen captures on everything so
that I can pick and choose later. Back at my office, I will
rewrite for what the end-user will read.
BTW, I cannot ask the resource person to write a rough draft of
the procedures...that would be doing too much of the work I'm
suppose to be doing.
Thanks for any helpful suggestions.
-- Barb --
bridley -at- usccmail -dot- bms -dot- com
TECHWR-L List Information
To send a message about technical communication to 2500+ list readers,
E-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send administrative commands
ALL other questions or problems concerning the list
should go to the listowner, Eric Ray, at ejray -at- ionet -dot- net -dot-
