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: technical documentation for software From:"Michael West" <mike -dot- west -at- oz -dot- quest -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 29 Dec 2000 16:39:39 +1100
SANDY BAKER writes:
> Does someone have advice about gathering and
> writing technical documentation for software?
Whoa.
You're not documenting "for software", you're
documenting software for people. You haven't
said which people. Are you responsible for
technical documentation of the code for developers
and testers? Or are you responsible for end-user
assistance material? Or both?
Their needs are different, so you need to handle
one task at a time.
The standard approach is first to define who your
audience is and what their needs are. If someone
is asking you to write a document that serves the
needs of both developers AND end-users, tell 'em
they're dreamin'.
When I need to create technical documentation
(as opposed to end-user assistance material), I
usually try to acquaint myself with the development
methodology in use by the client organization. A little
research usually turns up a listing of the types of
documents or specifications associated with a given
methodology. Then I try to find out who's supposed
to be using the results of my labors, and I ASK them
what they're expecting, what they're used to, and what
they like and don't like. Then I go from there, given the
time and resources available.
That should get you started.
--
Michael West
Technical Writer
Melbourne, Australia
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Sponsored by an
anonymous satisfied subscriber since 1994.
---
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.
