CSC 205
Winter 2005
Professor Stearns
Software Design Checklist

Use this checklist to verify your Software Design. Everyone is responsible for this verification; the editor takes the hit if there are problems.

General

1. Cover page contains Team Logo, 205 section # and date submitted.
2. Document is of professional quality.
3. Credits: the jobs of each individual are specified clearly.
   ("done by team" is explicitly disallowed)
4. Your team has done a design walk-through for every major use case.
   i.e. Ensure your design handles every major use case.

   English
   

5. Writing meets the standards of a the WPE level 4 or greater.
6. All English, including diagram text, is written in the 3rd person using active voice, present tense verbs.
7. There are no words from the bad words list

   Main Javadoc File
   

8. The overview is at least 2 pages and does a good job of describing your overall design that any sophomore CSC student would understand.
9. The UML diagram is embedded in the code.
10. All important variables are declared.
11. Your Javadoc URL is noted in the overview.

    Javadocs
    

12. Javadocs generated with -private flag
    
13. There are excellent preconditions for public member functions
    
14. UI design is clearly described and the basic philosophy is clear
    
15. Method summaries are one short sentence.
16. Whereever possible, names are from the problem domain.
17. All important variables are declared.
18. Function names use active voice present tense verbs.
19. All fields and member functions use the problem domain.
20. All member variables are private or protected.
21. There are get/set members for every attribute.
22. All names and relationships match the UML diagram
    

    UML Class Diagram
    

23. The names and relationships match the code exactly.
24. All collection class element types are shown.
    (e.g. A LinkedList of Clavitz - Clavitz is drawn)
25. There are no associations in the diagram.
    

    Compile/Javadoc
    

26. A script file of a successful compile and Javadoc is shown.
27. Javadoc has -private flag on.