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:Re: Dev. Cycle and the Manual From:Ginger Moskowitz <ginger -at- AATECH -dot- COM> Date:Tue, 4 May 1999 12:48:17 -0400
>In our organization we have five software development phases:
>analysis, requirements, design, coding, and testing.
This is pretty typical, but in my experience these phases are much like the
writing process, i.e., constant revisions are taking place based on things
learned each step of the way. I think documentation can begin once the
design phase is over, but you should not plan on final drafts until after
the coding phase. This allows the documentation to more accurately reflect
what's in the program, and doesn't restrict the engineers to the kinds of
changes they make to the program. Hopefully the testing phase will be long
enough to accomodate printing of the manuals. Customers can be given "beta"
manuals along with beta software in the meantime.
