documentation standards

[Tim Menzies]

---------- Forwarded message ----------
From: Tim Menzies <t...@menzies.us>
Date: Sun, Nov 30, 2008 at 8:27 PM
Subject: Re: More group 8 questions
To: Daniel Edward Sloan <dsl...@mix.wvu.edu>

On Sun, Nov 30, 2008 at 4:47 PM, Daniel Edward Sloan <dsl...@mix.wvu.edu> wrote:

Dr. Menzies,

Had another set of quick questions, this time per the trunk
documentation. I am about to move our documentation into trunk, but I'm
not sure exactly how you want it laid out. I'm assuming all the stuff
related to our deftests will simply get thrown into "tests."

please view the deftests as a way to document your code. e.g. as the following deftest shows... in this view, deftests are sprinkled through out the document
 

What about
our actual code for our standard cycle, however? Tools? Tricks? Also,
how should I differentiate our documentation from everybody else's?

when we look at iccle, i'll ask you "what pages are yours?" and we'll look through them.
 

For
now I'm just going to assume a naming scheme where I place "(Group 8)"
in front of all of our chapter names, because that makes the most sense
logically. Still, some direction on all of the above would be much
appreciated.

you might want to use that convention for the for wp files (but please, not the code files)  but as i said above, i'll ask you to guide me through it all

Thanks,
Group 8

--
timm, a/prof, csee, wvu, usa

Bill Hoest

--
timm, a/prof, csee, wvu, usa

Johnny Carson