Outline for Project Reports
-
Project Overview
-
What problem it solves
-
How it is perceived from a user's perspective
-
Several use-case studies
-
user action / system response
-
A picture that shows the general flow of information between tiers of system
-
Tiers
-
Tier#1 (Browser)
-
List of services provided (high level description)
-
Service#1
-
Detailed description of user interface
-
What happens (technical description) at this tier
-
Service#2
-
Etc.
-
Tier#2 (Web Server)
-
List of services provided (high level description)
-
Service#1
-
Detailed description of service interface
-
What happens (technical description)
-
Service#2
-
Etc.
-
Beans used to cache state (DB or session)
-
Bean#1
-
State
-
Services
-
Bean#2
-
Etc.
-
Tier#3 (Database)
-
ER diagrams
-
Semantics associated with each relation
-
Expected operations and queries
-
Technologies Employed
-
Technology#1
-
Brief description
-
Observations of strengths/weaknesses
-
Technology#2
-
Etc.
-
Post Mortem
-
Problems encountered and solutions discovered
-
Tools you wish you had
-
Approaches you would take if redoing it
-
What you learned