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: "Technical Documentation" for a PowerBuilder App
Subject:Re: "Technical Documentation" for a PowerBuilder App From:Alexia Prendergast <alexiap -at- SEAGATESOFTWARE -dot- COM> Date:Thu, 4 Sep 1997 14:15:55 -0400
Can you provide some more information about what the
product does and who are its users? That will determine
what info they need. "Technical Documentation" can
mean anything.
If this is going to OEM customers, for example, they'll
need programming docs describing how to customize
and build the customized app. If this is going to end users,
they don't need all the behind-the-scenes info. Is there
any network or database administration involved in
maintaining this product? If so, they'll probably need an
admin guide describing how to configure, maintain, tune,
and troubleshoot from a systems POV. And so on.
>-----Original Message-----
>From: Zigo, Joy [SMTP:Joy -dot- Zigo -at- HARPERCOLLINS -dot- COM]
>Sent: Thursday, September 04, 1997 2:12 PM
>To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
>Subject: "Technical Documentation" for a PowerBuilder App
>
>TechWrlers of the Planet--
>
>A friend has been asked to write "technical documentation," as well as
>end user documentation and an online Help file, for an application made
>in PowerBuilder by developers at a start-up company. Since his clients
>do not know exactly what they need, and he was not sure what to provide,
>he asked me for advice about what kinds of information each type of
>documentation should include.
>
>I've done end user documentation and help files, and have told him my
>views about those. But I haven't ever done "technical documentation."
>What are the major categories of information that you would include in
>it? Is any of the information that you would include specific to the
>PowerBuilder environment?
>
>Please reply to me directly, as I subscribe to the list in Digest form,
>and I'll pass your collective wisdom on to him as well as summarizing
>for the list.
>
>Many thanks--Joy
>.................................
>joy -dot- zigo -at- harpercollins -dot- com
>
>Speaking strictly for myself, not for HarperCollins.
>
> TECHWR-L (Technical Communication) List Information: To send a message
>to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
> to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
> Search the archives at http://www.documentation.com/ or search and
>browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
