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.
Bruce McCowan wrote:
>
> I am hoping for some opinions on what constitutes good system documentation
> for a Windows application.
I started typing an answer, then realized I wasn't quite sure where you
are coming from. If you could answer the following, I might be able to
help a little:
Are you documenting an API or an application?
If it's for an API, are you documenting it for developers who will write
code that calls API functions, or are you documenting it for programmers
who will be maintaining the internal code of the API itself?
L.
--
Linda K. Sherman <linsherm -at- gte -dot- net>
Freelance Writer: Technical - Business - Government
