Re: Documenting from Program Specs

Subject: Re: Documenting from Program Specs
From: Kris Olberg <kjolberg -at- IX -dot- NETCOM -dot- COM>
Date: Fri, 6 Feb 1998 13:46:26 -0600

-----Original Message-----
From: Tom Johnson <johnsont -at- freeway -dot- net>

>The goal is to have the documentation completed the same time as the
>program. The programmers will be responsible for making sure the code
>matches the specs and the manual. I remember a brief thread about this a
>year or more ago and I wondered if it ever works in real life.

Yes, it does work, but plan for changes. The product almost never looks/acts
exactly as described in the specs. It will evolve slightly even through the
development process, so you need to be flexible. Talk with the programmers
several times a week to discover what's changing and how.

>Have others found this to be a workable approach? Have you found fewer
>revisions are necessary? Right now I'm looking forward to trying this
>approach. I've also been asked to voice any concerns I have regarding
>usability. Any comments?

I've never found this approach to decrease revisions. In fact, it may
increase them, but I have no facts to back up that assertion. However, the
resulting documentation was highly accurate.

kolberg -at- actamed -dot- com
kris -at- olberg -dot- com

Previous by Author: Re: Headers and Footers
Next by Author: Re: Justification for task-based documentation
Previous by Thread: Re: Documenting from Program Specs
Next by Thread: Re: Downtime (Planning for online help)

What this post helpful? Share it with friends and colleagues:

Sponsored Ads