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:Need help - System documentation From:Emily Skarzenski <71220 -dot- 341 -at- COMPUSERVE -dot- COM> Date:Tue, 28 May 1996 14:43:27 EDT
I need some expert advice from the software-techie-types out there.
My company is contemplating looking for an investor for a client-server product
that we have been developing for a while. Our management has given my entire
project group (programmers, testers, presales people, and writers) the job of
creating system documentation that potential partners could use to evaluate our
system to determine if they would be interested in investing in it. We haven't
been given much further direction, and probably won't be.
My boss and me -- the writers -- have been put in charge of this effort. Neither
he nor I have ever developed this kind of documentation. (I have done technical
system overviews, but nothing this exhaustive.) Setting aside the legal issues
of confidentiality (which will be our lawyers' job to handle), what kind of
information should this document contain? What shouldn't it contain, if
Suggestions and war stories are deeply appreciated.
71220 -dot- 341 -at- compuserve -dot- com
Post Message: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
Get Commands: LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU with "help" in body.
Unsubscribe: LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU with "signoff TECHWR-L"
Listowner: ejray -at- ionet -dot- net