 | Overview:
 | Brief description/background for the project (perhaps by reference to
the SRD or an earlier product presentation) |
| Skills and knowledge areas: what things did you need to know/learn
about in this project, e.g., database, web, OpenGL, debugging, GUI toolkits,
networking, etc.
 | If you found helpful texts, web sites, readme files, user groups,
software toolkits, etc. along the way, reference those resources. |
|
| Tricks and Techniques: Almost every application has some "quirks", the
oddities in your code that only those intimate with the development
recognize. For example, perhaps you've got to edit a certain configuration
file (in a way other than what your "official" documentation states, before
it reads correctly. Our maybe your database has to have a certain
permission structure to make it editable by the administrator.
| Consider carefully what tricks. gotcha's and "features" exist in your
application and do us the favor of documenting them. |
|
| Candid assessment of the state of your application:
| Functions Implemented
| Estimated robustness and/or completeness of major functions |
| Prioritized recommendations for corrections/improvements (as
applicable) |
|
| Functions Planned: probably you didn't finish everything you set out
to do in the requirements document. What was left undone? Of that which
was left undone, what was most important?
| Degree of importance to overall project |
| Estimated effort to implement function |
|
| Future Enhancements/Modifications: along the way you also probably
thought of other cool ideas that you just didn't have the resources to
implement.
| Make recommendations on how this project could be improved/make more
useful (e.g., what new features would you promote now being more
familiar with the program/problem area) |
|
|
|
| References:
| Provide pointers to product documents: PMP, SRD, SDD, UM, Installation
Manual, and Final Product Presentation (you can provide these on a CD or
create the appropriate directory hierarchy to archive these on the T: drive)
|
| File listing
| List each file which constitutes the "program", documentation, and
development framework |
| Typically you'll want to list the files in some organizational fashion
with brief descriptions on the purpose of each file. Consider using the
following categorization:
| source files |
| documentation files |
| configuration files |
| makefiles |
| scripts |
| references (readme files, web links, .pdfs, etc.) |
| tutorials |
| test files |
| project web pages |
| utilities and support software |
|
| File descriptions can be documented in the headers of your files and
mantenance manual documentation generated automatically (if you prefer,
not required). |
|
|