Fog Creek Software
Discussion Board




Design docs for existing functionality

Has anyone attempted to write design docs for existing code/component?

John
Wednesday, May 14, 2003


Yes, and in many ways, it's the only way to do it.

Why?

Joe AA
Wednesday, May 14, 2003

Well, we have lots of C/C++ code with us and we have been asked to write design documents for the applications.

John
Wednesday, May 14, 2003

Writing a design doc for existing code ought to be much easier than writing a design doc before coding. For one thing, you don't have to make any decisions. You just have to describe what the system is already doing. The only potential problem that I can see is if you've got old code and nobody remembers what it does.

Beth Linker
Wednesday, May 14, 2003

We are totally new to the code. There  is no one to help us on this.

John
Thursday, May 15, 2003

Maybe you'd like to reverse-engineer a picture of the code, using some tool like http://www.scitools.com/ucpp.html or another.

Christopher Wells
Thursday, May 15, 2003


Or take the classical approach... start reading the code.

Joe AA
Thursday, May 15, 2003

Um, good luck.

D'you realize, John, that the only question you've asked is whether we've done this before?  If you ask a more detailed question, I'll be happy to answer, but right now, there's nothing to talk about.

Brent P. Newhall
Thursday, May 15, 2003

Well, I'd like to how to do it :-). Right now we are reading thru the code & debugging the app. How to draw the interaction diagrams?

John
Friday, May 16, 2003

*  Recent Topics

*  Fog Creek Home