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.
I'm not convinced. He also wrote, "Design decisions are often documented
throughout other artifacts, such as system overviews and source code,
although you may choose to have a separate document when appropriate to the
situation." Sounds like his after-the-fact system overview is *instead of* a
pre-development requirements spec.
> -----Original Message-----
> From: k k
> Sent: Wednesday, March 03, 2004 2:32 PM
> To: TECHWR-L
> Subject: RE: IT documentation
> I think the man wrote exactly what he meant. It makes
> sense if the overview isn't a design document. If it's
> just an executive summary type of document, or
> something else meant to give a customer peace of mind,
> then you're better off waiting to do the doc until the
> design is fairly stable. That way the reader doesn't
> see any big differences between what it says in the
> overview and what he actually sees in the product.