This page describes the expected general structure of assignment, APT and FYP documents. Please note that the following is just an indication and that certain types of projects might require different documentation structures and styles. Of course, the length and content of different project types (assignments, APTs, FYPs) will vary. Ask your tutor.
- Cover Page - University Logo, Name, Title, etc.. (A/P/F).
- Plagiarism Declaration Page - Downloadable from this site. (A/P).
- Abstract (P/F).
- Optional Dedication Page (F).
- Acknowledgements Page (F).
- Table of Contents (A/P/F).
- List of Tables (P/F).
- List of Figures (P/F).
- List of Algorithms - If Applicable (P/F).
- Chapter 1 - Introduction - Contains Aims, Non-Aims, Objectives, Detailed Explanation Of Aims, Contents of Document, Chapter Break Down (A/P/F).
- Chapter 2 - Background - Background Theory, Literature Review, Current State-Of-The-Art, etc... (A/P/F).
- Chapter 3, etc... - {Topic Background} - If the Project Involves Multiple Areas (e.g. Genetic Algorithms, Search Algorithms, Machine Learning), there should be chapters or at least sections explaining the theory and details of each area (e.g. An Introduction to Machine Learining) (P/F).
- Chapter 4 - Specification And Design - General Architecture, Modulatity, Any Software Engineering Principles and Techniques, GUI Design, Flowcharts, etc... (A/P/F).
- Chapter 5 - Implementation - Details of How The Artifact was Developed - Class Design, Error Handling, Technical Details, etc... (A/P/F).
- Chapter 6 - Testing, Results and Evaluation - Testing Objectives, Techniques, Test Cases, Results, Interpretation of Results, General Observations (A/P/F).
- Chapter 7 - Conclusions and Future Work - Summaries of Results, General Goals Met? Possible Future Research, Conclusion (A/P/F).
- Appendix A - Tables of Detailed Results (A/P/F).
- Appendix B - Any User Manual inclugind Installation (A/P/F).
- Appendix C - Any Sample Data (A/P/F).
- Appendix D - Contents of CD Rom (A/P/F).
Note: Source code should NOT be printed and included as an appendix.
Legend:
- A = Assignment.
- P = Assigned Practical Task (APT).
- F = Final Year Project (FYP)