"Documentation by paper"

Richard Kenner kenner@vlsi1.ultra.nyu.edu
Wed Feb 4 18:05:00 GMT 2004


    In my experience, the best documention is written by someone with good
    technical writing skill as well as some programming knowledge who
    initially doesn't understand the code, but who learns what he or she needs
    to know by a dialog with the author.  

I agree you can develope *adequate* documentation that way, but strongly
disagree that it's the *best*.  When you do this after-the-fact, the author
will likely have forgotten many things that were important to have known
when writing the code.  Also, it's very hard to really find out everything
significant in this "game of 20 questions" approach.



More information about the Gcc mailing list