All Class announcements will be made here.
SE2: Software Design and Architecture is the second course of the three software engineering capstone project courses, offered jointly by the David R. Cheriton School of Computer Science and the Department of Electrical and Computer Engineering at the University of Waterloo.
Class will be in-person at MC 2034 01:00-02:20MW or 02:30-03:50MW unless the university decides to move to virtual. If we go virtual, at the same times we will meet in a zoom room whose link I will email all of you.
This will be a flipped classroom. I will post slides with scripts and the corresponding video recordings on Learn at least two days before class. I will strive to get them on earlier.
In class we will do exercises and quiz type questions and group discussions. Note that these are not evaluated. You are welcome and encouraged to attend at they will certainly make the material covered in the slides and recordings more concrete and meaningful. But you are not required to.
Official administrative entry and outline.
Important dates and information will be posted here on this website. The official syllabus is also the contents on this website. You can reach this website from the corresponding entry in learn.uwaterloo.ca.
While the course does not have a required textbook, the following are good readings on this subject.
This term we will be using Learn for class discussion. Rather than emailing questions to the teaching staff, I encourage you to post your questions on Learn.
If you need to ask a question regarding the grades or something personal then please email the instructor. Prefix the subject line with CS446/ECE452/CS646 for a prompt reply.
All TAs will be answering questions mostly only on Learn. If there is a specific need to actually talk to a TA, please email them to get a virtual meeting link that can be used. They have preferred times set up (below). Please try to schedule during these times as much as possible.
The class will use the Learn system for all submissions and grades. Once you are registered, you will be able to access learn and check the dropboxes for submissions and view your grades.
| Date | Topics | Notes |
|---|---|---|
| May 02 | Introduction to the Class, Expectations, Admin | |
| May 04 | Introduction to Software Architecture | |
| May 09 | Non-Functional Properties. | |
| May 11 | Human Values in Software Engineering | |
| May 16 | UML Intro | |
| May 18 | Architectural views & decomposition | |
| May 23 | Victoria Day. No Class. | |
| May 25 | Intro to building Android apps - Part 1 | |
| May 30 | Intro to building Android apps - Part 2 | |
| June 01 | Project Proposal |
|
| June 06 | Arch Styles Intro | |
| June 08 | Arch Styles - Part 1 | |
| June 13 | Arch Styles - Part 2 | |
| June 15 | Arch Styles - Part 3 | |
| June 20 | Design Patterns Introduction | |
| June 22 | Design Patterns - Part 1 | |
| June 27 | Project Prototype Demo | |
| June 29 | Project Prototype Demo | |
| July 04 | Design Patterns - Part 2 | |
| July 06 | Design Patterns - Part 3 | |
| July 11 | Release Engineering - Part 1 | |
| July 13 | Release Engineering - Continuous Experimentation | |
| July 18 | No Class | |
| July 20 | Final Project Presentation | |
| July 25 | Final Project Presentation |
The project forms an integral part of this course. Here are some of the hard requirements:
The three goals of the project is to
When coming up with your own app there are only three soft restrictions on the app idea itself: no database management apps will be accepted (e.g., simple CRUD apps that do not make sense in a mobile context); apps that require crowd buy-in are not acceptable (e.g., apps that would require large numbers of people to contribute content to be viably useful); apps that require a complex server infrastructure are also not acceptable. If your app has any of these components, then you are responsible to have the DB or server infrastructure or crowd set up so that you can demo the app and we can test it too.
If you are unable to come up with an idea, don't worry. We are working with an open source product team to set up an idea for you. This is an app that has social good built into it. This will be the default app that several teams can build at the same time in parallel.
If after the proposal, we feel that the app idea is too simple or too easy, then you will need to change to our default app idea above. The teams will then have to implement our suggested idea. See below for some great ideas from the past.
Human values: In the proposal, you will detail the functional requirements, non-functional properties, and human values that your app addresses. You will also state who some of your stakeholders are and which population of users that your app is useful for.
Buddy team evaluation: You will receive the proposal of another team. Your goal is to look at the proposal and find out which populations could be harmed and what harm could be created by the features of the app. You are expected to think critically and come up with an exhaustive list. The instructor and TAs will also come up with a list. You are evaluated on how similar you are to our list.
Pivot: The lists of harm that exist in the app created by the instructor team and the buddy team will be shared with the team that proposed the project by the prototype demo stage. When you receive your list, you are expected to make changes in the project so that the harm is mitigated. This change has to be documented by the final demo and written deliverable.
The projects will be completed in teams of six. If it has less than six or more than six, you will need to explicitly get permission from the instructor. You should select your own team; if you do not have a team or your team has less than six members, please post on the appropriate Learn discussion thread.
All project grades taken together (D1, D2, D3, D6, D7) need not be the same for all team members. Each team member will get a score based on effort. Please only commit your personal contribution to the repository. Do not commit for another team member. Commits to the repo are an important signal to us. Additionally, projects will have a difficulty scale applied to them by the instructor and TAs. The scale formula will be:
(total score for the team member across all project deliverables D1, D2, D3, D6, D7 + bonus) * (scale/100) = final project gradeScale will range between 0 and 100. The components of the scaling mark will be determined by:
https://developer.android.com/studio/install
Use the above link to start installing Android Studio in Linux/Win/Mac Machines beforehand. The download size may vary based on the operating system/region and locale ( 800 MB ) for Android Studio alone. Always choose the latest version of Android Studio and corresponding Gradle plugin to build APK files, which helps in reviewing code and evaluation.
SDK Installation: Use the latest Stable Android Version for SDK Compilation rather than the beta version. The preferable version can be from Android M ( API 23 ) to Android R ( API 30 ). As soon as you install the Android Studio, start selecting the preferred android version ( at least 1 ) and download the corresponding emulator, SDK Library, SDK Build Tools, and other utilities. Kindly allocate around 20 GB physical space for Android Studio and SDK Installation and a stable internet connection to complete all the installation setup in advance.
Emulator vs. Android Phone: Kindly use Android Mobile phone for testing by connecting it via USB for debugging, which will have a low impact on system resources while building Android apps. Otherwise, kindly install x86 Google Play/Google API Supported Android emulator for instant access and testing. Do not install ARM or other arch types that are not optimized for cold startup/booting.
Reliable Network Connection: Kindly ensure about reliable network connection for downloading Android Studio and SDK Libraries. Additional data will be required while using third party libraries to build an application or while syncing via Gradle.
A selection of project videos from 2017 are included in this playlist to help you get an idea of the scope of projects suitable for the course.
| Deliverable | Date | Format | Value |
|---|---|---|---|
| Project Team Selection | May 13 | On Learn | No Grade |
| D1: Proposal Document | June 03 | Upload to Learn | 5% |
| D2: Buddy team's evaluation | June 10 | Upload to Learn | 5% |
| D3: Prototype Demo | June 27/29 | Present in Class/Upload to Learn | 5% |
| D3: Prototype Document | June 30 (Thursday instead of Friday due to Canada Day) | Upload to Learn | 10% |
| D4: Architecture Style Examples | Upload to Learn | 10% | |
| D5: Design Pattern Examples | July 15 | Upload to Learn | 10% |
| D6: Final Presentation | July 20/25 | Present in Class/Upload to Learn | 5% |
| D6: Arch + Design Document | July 20 (Note this is a Wed) | Upload to Learn | 10% |
| D7: Final Status Report | July 26 (Last Day, Tuesday) | Upload to Learn | 5% |
| Final Exam | TBD | 35% |
For graduate students only: in addition to the project and other assessments above, you will perform an individual graduate project. The graduate project is worth 25% of your grade; your final grade will be calculated by scaling down the above assessments from 100% to 75%.
Three types of graduate projects are possible:
The goal of this style of project is to identify some problem developers encounter in practice, find some solution, and validate that the solution helps with the initial problem. I would recommend drawing upon your experience as you write code to identify some problem that has inhibited you in the past and fix it.
The outcome of this project will be a short (5-6 page) paper describing the problem, your solution, a comparison to related approaches, and some form of validation.
The goal of this kind of project is to gain a more complete understanding of a topic relevant to this course. The outcome of this project will be a critical summary of the state-of-the-art on your selected topic; this summary should be 8-10 pages. It is essential that this summary synthesizes the surveyed literature to identify important themes, findings, and open questions.
The goal of this project is to provide a validation of some previously-existing development tool from the research community. The tool you validate must be related to the course material. The outcome of this project will be a 6-8 page paper describing your experience with the tool outlining its strengths, weaknesses, and avenues for future improvement.
There are two deliverables for the graduate project:
The Faculty of Math encourages students to seek out mental health support if needed. On-campus Resources: