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:info sources for software writing From:Mike Beyries <beyries -at- THELMA -dot- CSISDN -dot- COM> Date:Wed, 1 Mar 1995 08:02:49 -0800
Herman,
after 15 years of documenting [mostly] software products, I find
that the typical information sources (in their approximate order
of usefulness) are:
1) alpha/demo versions of the product (if new) or previous versions
2) individual contributing engineers/programmers
3) a marketing product manager or engineering project manager
4) engineering "documentation" = [specs, comments in code, code]
5) high-level project plans and schedules
6) development's own internal presentations & training materials
7) bug reports & source control data
8) marketing/engineering feature lists
So -- are you planning to share your forthcoming document(s) with those
on the list?
Regards,
Mike Beyries (beyries -at- csisdn -dot- com)
Technical Communications and Development Support
Information Resource Engineering, Inc. (IRE)
Mountain View, CA U.S.A. (415) 903-2589
This is *NOT* IRE's opinion
