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.
New to tech writing ... another "lamb" tossed into the fray! I can write
and have been reading tech documentation for *many* years as I started with
Digital in 1974 working on computer products. But, the jargon *for*
creating them has me a bit puzzled.
For example: I'm working on a project right now for software that's in
development. My boss wants 1)Install guide - straightforward, I understand
that
2) Programmer's guide - again, easy enough, I have the outline for the API
and need to fill in details --- but what exactly is he looking for to put
into 3)an Administration guide???
I understand that part of it will be configuring the software for each
machine, but beyond that ... ???
Any hints, tips, tricks, demos to point me to??
Thanks!
Debbi
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Debbi Baird
Web Developer / Tech Writer
TopicalNet.com
dbaird -at- topicalnet -dot- com http://www.TopicalNet.com
Ph. 781-932-8400 x104
Fx. 781-932-2558
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
"Where the law of the majority ceases to be
acknowledged, there government ends; the
law of the strongest takes its place, and life
and property are his who can take them."
-- Thomas Jefferson to Annapolis Citizens,
1809
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/
---
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.
