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: When Worlds Collide: McConnell meets Hacko From:Janice Gelb <janiceg -at- marvin -dot- eng -dot- sun -dot- com> To:techwr-l -at- lists -dot- raycomm -dot- com Date:Thu, 22 Jun 2000 13:02:56 -0700 (PDT)
In article ORG -at- lists -dot- raycomm -dot- com, droberts63 -at- earthlink -dot- net (dan roberts) writes:
>
> McConnell advises that, although doc development extends through the
> development life-cycle, the bulk of user doc can be completed in the
> early stages of the SW development cycle, pretty much after the SW
> prototype is completed. The user doc serves not only as end-user doc
> but also as a detailed functional spec used during the SW architecture,
> development, and QA phases.
>
> Hackos contends that the initial phases of doc development should be
> evoted to analysis and planning, including a detailed doc plan--but
> little in the way of writing information that the end-user will
> ultimately see.
>
My immediate response is colored by the fact that I
have mainly worked in large organizations. That said,
my feeling is that if they want someone to write a
functional spec, they should hire or assign someone
to do that. Obviously, the spec needs to be written
early because so many groups depend on it to do
their own jobs, and the engineers themselves should
have it to write the code against.
However, specs are not user's guides. The reason Hackos
recommends that writers not write detailed information
for the end user in early stages of the project is that
nearly all of it will have to be rewritten as the
product changes.
***********************************************************************
Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- marvin -dot- eng -dot- sun -dot- com | this message is the return address. http://www.geocities.com/Area51/8018/index.html
"Politics is show business for ugly people" -- James Carville