Re: Lines of documentation per LOC

[mat@mole-end.matawan.nj.us]

In article <1994Oct26.094543.24213@sei.cmu.edu>, lpb@sei.cmu.edu (Loic Briand) writes:
> 
> In article <EACHUS.94Oct25190056@spectre.mitre.org>, eachus@spectre.mitre.org (Robert I. Eachus) writes:
> |> In article <1994Oct25.170005.27711@sei.cmu.edu> lpb@sei.cmu.edu (Loic Briand) writes:

Documenting _after_ the program is done is like drawing plans
after the building is built.

> |>  > Is there any document or source of information that provides
> |>  > an accepted (?) ratio (lines of documentation / lines of code) for a 
> |>  > software design document (SDD)?

A better question, I think, is `how many lines of code result from a line
of SDD?'

The SDD, after all, specifies the code, and not the other way around.

> Robert, I am not totally stupid. I _know_ that the amount of documentation is
> function of the code.  The problem is that when you have a client who ask for
> 10 lines of doc par LOC and you have budgeted 0.1 (based on the expected
> complexity of your code), you have to prove your point.

I'd start by explaining that you write the code _from_ the design documents,
not the other way around.

If the design documents are sufficient to specify working code, there
should be no question about whether it is complete enough for the code.
-- 
 (This man's opinions are his own.)
 From mole-end				Mark Terribile
 mat@mole-end.matawan.nj.us, Somewhere in Matawan, NJ
	(Training and consulting in C, C++, UNIX, etc.)