Your journal is a living document that will be created and added to throughout the semester.
The journals are are completed and marked individually, although there will be components that are ideally done with your project partner. Journals will be due weekly, starting in Week 2, and there will be 10 of them.
The journal is meant to fill in the gaps between the theoretical knowledge covered in lecture and the applied knowledge in the project with your own reflection. Practicing thoughtful reflection is becoming increasingly important for emerging software engineers with the proliferation of Generative AI.
In addition, as the Journals provide a bonus grade to your quiz and project marks, they act to cover any missed marks due to small ambiguities or misinterpretations in the specification and quiz questions. The course team works hard to make the project specification and quiz questions as clear as possible, but due to the closed format of grading (true/false, multiple choice, passing/failing tests), we want to offer some leniency for misinterpretation or ambiguity. The journals provide an additional way to demonstrate your understanding of the course concepts.
Each week, starting in week 2, you will submit your journal to your individual repository. A TA will provide written feedback on your journal and the first lab meeting following the journal due date, you will meet with your lab TA to discussion the journal.
You will be provisioned your own repository for your Project Journal. You will assemble one markdown Github Issue per journal entry, which may include multimedia components.
The details of what is required for each Journal are specified on the other subpages!
Journals will contain questions that involve both class material and the project.
Below is a rough schedule of journal questions related to the project:
Journal 1 (C0 is due): C0 Reflection
Journal 2 (C1 starts): Teamwork Agreement
Journal 3: C1 Breakdown of Specification into Tasks on a Schedule
Journal 4 (C1 ends): C1 Reflection
Journal 5 (C2 starts): C2 Breakdown of Specification into User Stories
Journal 6: No project question
Journal 7 (C2 ends): C2 Reflection
Journal 8 (C3 starts): C3 Breakdown of Specification into User Stories
Journal 9: No project question
Journal 10 (C3 ends): C3 Reflection
Each journal is worth 1%, where the first 5 contribute towards your journal grade, and the next 5 contribute towards a bonus. The bonus is applied to your quiz and project grades. More details are in the Grading section of the main page of the course website.
To receive full marks for your journal:
You must Format and Submit the Journal as per the specification (as detailed below)
Your journal must be organized and easy to read. You should create titles for the different questions within the journal. If the TA needs to spend more than a couple minutes trying to find your response to a question, your journal is not organized enough!
You must attend your lab. In lab, you will discuss your journal with your TA.
Must be written entirely by you without the use of any form of AI. Journals are meant to help you reflect, practice, and develop skills as a software engineer; any suspected violations will be flagged and considered in breach of course policy (as stated at the bottom of the homepage).
You will receive a 0, 0.5 or 1 for a mark:
0 = No submission
0.5 = Partially complete submission or a submission that contains very poorly answered questions
1 = Clear demonstration of effort to answer each question
Journals should be written and submitted as Github Issues on your journal repository.
Failure to submit the Journal as an issue or to title it correctly will result in a 0.
Note: some questions will ask you to link to your code. Detailed instructions are provided in the GitHub Docs.
To create a Github Issue, navigate to the "Issues" tab on your journal repo, aka your C0 repo (journal_<githubId>), and create a new Issue.
Title the Issue with the name of the Journal, e.g. "Journal 1", "Journal 2".