Ruven E Brooks <[EMAIL PROTECTED]> writes:
> >I have just been given the assignment of investigating techniques for >documenting a 1.5 million line system. > >Suppose that you were hired (at an outrageous salary, of course) to be the >chief architect of this system. >If you could have a 20 page initial document on the internal structure of this >system, what would that document contain? > >My own initial thought was some kind of box-and-line major subsystems document >but the exact semantics of the boxes >and the lines is still open. My superprogrammer colleague suggested that what >he wanted was a list of the actual files >that were installed, together with an explanation of each one. > >Other thoughts, suggestions are welcome. > >Ruven Brooks Dave Parnas Elequently addressed this question in two papers "Using Documentation as a Design Medium" and a "A rational Design Process, How and Why to Fake It". Since these papers, which include two examples, a rationale and some useful and very practical commentary, defined the field for documentation in Software Engineering, I would begin there. Tom Wheeler University of Maine > > ---------------------------------------------------------------------- PPIG Discuss List (discuss@ppig.org) Discuss admin: http://limitlessmail.net/mailman/listinfo/discuss Announce admin: http://limitlessmail.net/mailman/listinfo/announce PPIG Discuss archive: http://www.mail-archive.com/discuss%40ppig.org/
