Year - Semester
Author:
- About
- Acknowledgements
- Setup
- Task Solutions
- Task Notes
- Reflections
- Summary
- Sources
- Resources / Tools
A concise overview of the project: its purpose, scope, and any relevant context. Include the academic setting, goals, and your initial thoughts when approaching the assignment.
Documentation of external contributions, including insights or solutions inspired by:
Academic staff External authors Forums and technical communities AI-assisted input Any additional sources worth crediting
Clear instructions for reproducing or running the project. Depending on the project type, this section may include:
System requirements Installation steps Folder structure explanation Database setup (if applicable) Environment variables How to run or test the project
A structured list of links or references to completed tasks or solution files. Useful for navigation when the assignment is divided into multiple parts.
Notes, decisions, reasoning, and supplementary explanations for each task. Can also serve as a place to document AI assistance if preferred.
Description, notes, and clarifications related to Task 1.
Something
Something else
And so on
A structured reflection section. Consider addressing:
What went well Challenges encountered How issues were resolved Lessons learned Possible improvements if revisiting the project
A brief summary of your overall experience, including general outcomes and any final remarks on the workflow or results.
A list of all sources referenced while working on this project. This may include:
Articles Tutorials Documentation Academic resources Forum threads AI-generated insights
Any external tools or utilities used throughout the development process. Examples:
IDEs Database tools Debugging tools Libraries or frameworks Command-line utilities
Add license information here if relevant for the project.
(Microsoft Copilot was fed the original template and asked to "fancify" it.
Layout is not changed, but notes under headers have been adjusted to sound more academic as that is
not my strong suit!)
Final notes:
Feel free to make changes to this template. This is just something very basic that I threw together in a couple of minutes.