1. COMP3121E-Commerce Technologies Richard Henson University of Worcester December2011

2. Week 10: Documenting a Client-Server System • Explain the fundamental differences between documenting client-server and documenting conventional systems • Explain the importance of presenting a data model in the documentation • Use software tools to assist documentation of web pages, web sites, and database design

3. What is client-side and what is server side? • Everything that is displayed using HTML… client side • Everything that interrogates databases, and databases themselves… server side • What about the rest of the coding? • JavaScript? • C#? • Asp.net controls?

4. Putting this into a write up • More challenging than a conventional website/set of programme coding • It helps to have separate headings for “client side” and “server side” • Site will be marked as a Visual Studio 2010 project • essential that all server code and the database to run the site are included on the media handed in with the assignment write up!!!

5. How to document… • Project usually have four phases: • Analysis • Design • Implementation • Evaluaation • Your assignment 2 can be considered to be a mini-project…

6. What to include in the write up • The assignment brief is your spec (no analysis section therefore necessary!!!) • Requirements: • “Design” (client & server) • “Implementation” • “Evaluation”

7. Design • Should include: • site & database design diagrams • screen dump(s) to show common page format(s) • test plan • should refer to code (e.g. scripts) by filename so marker can cross-check with file(s) on removable media

8. Relative and Absolute Paths • For small databases and simplicity Access works well…. • with one exceptiion • Access requires an absolute path • e.g. X:\myfolder\yourfolder\database.accdb • SQL Server, and MySQL can cope with a relative path: • e.g. ..\yourfolder\database.mdf

9. Implementation • Should include some of: • code sections that you may want to explain or bring to the attention of the marker • database connection string(s) & path to Access database in working project • A description of problems encountered and how overcome

10. Testing • Expected results should have been added at design stage • Actual results obtained when test plan put into action • “Actual v Expected” comparison should be presented on a table

11. Retesting & Rollout • Any differences between expected/actual results need to be resolved • Changes made as a result of testing should also be documented • Completed product copied to removable medium (keep a copy!)

12. Evaluation • You should include: • what others (i.e. prospective shoppers) think of the site • how well the completed site meets the spec (or goes beyond it… or could do…) • A personal reflection of your experiences in doing the assignment, and anything else you’d like to have done with it, if you had more time…

13. Good Luck and have a Great Xmas! Practical Workshops available by appointment… until the day before hand-in (not 12th -16th Dec )