[Sca-cooks] Documentation

Terry Decker t.d.decker at att.net
Thu Aug 23 14:34:19 PDT 2012



>I am using a new format (for me) for documentation that I really like.
> Introduction - 1 paragraph introducing the project
> Overview or Abstract - The core problem, situation or context
> General Information - What? When? Where? Who? How? Why?
> Review of specific parts of the project - This varies from project to 
> project
> Challenges
> Key Learnings
> Areas for Further Research
> Keep it short (of course this depends on the scope of the project but the 
> above should be UNDER 10 double space, manuscript formatted pages)
> Use appendix if you need more space for information.
> I use this format for projects that are object based, research paper based 
> and process based.
> Eduardo

More information about the Sca-cooks mailing list