|
|
CSS 443 - |
Sample Design Documentation from pass mp1
Here are
some sample design documentations on mp1 written by pass students.
|
From |
Why I like them |
Document |
|
|
|
|
|
Spring 2001 |
I like these because they did a
very good separating in-line code comments from the documentation of the design
of their classes/system. Notice the brief documentation, where groups of
similar functions are discussed together. I also like the worst case
analysis, where they clearly separated the cost per statements from the
number of times a statement will be executed. In Yan's case, a separate
column is dedicated to analizing the worst case, clearly presents the
behavior of the algorithm. |
William Kallander's design doc and runtime analysis |
|
|
|
|
|
Winter 2001 |
Camille's doc is clear with detailed analysis. While Benjamin's
is short and precise. Notice Benjamin's pseudo code is detached from the
actual implementation (there are not many references to actual variables) and
thus demonstrated the link list concept more clearly. Camille's has very
extensive use of comments, really help understanding the code. |
Camille Scott's Design Doc |
CSS 443 Home |
Kelvin Sung |
Kelvin's Research Page
| CSS Home |
UW Bothell | UW Seattle
|
|
|
Last updated: Jan 1, 2002 KS |
