Git Product home page Git Product logo

course's Introduction

Title Subtitle Author
Documenting and Understanding Software Systems
CRN 2366{2,3,4} - SENG 480A/CSC485A/CSC578A - A01
Neil Ernst

Schedule and Topics - Spring 2019

The following schedule is subject to change, and will change.

Class Topics Other Resources Readings Deadlines
Jan 7 Intro; introductions; Project outlined. What is Software Architecture? text chapter 1
Jan 10 Software arch overview. text chapter 2
Jan 14 Omar - Github/Git tutorial
Jan 17 Group project meetings (in class)
Jan 21 Reading Code. chapter 3 text, source code of web crawler
Jan 24 Architecture Stakeholders and Requirements. Team kickoff text chapter 16 M0 due
Jan 28 More on Requirements and Scenarios
Feb 1 Views on Architecture - Modules text chapter 18 M1 due
Feb 4 Views part 2 - C&C SEI view example text chapter 4
Feb 7 Architecture and Design What is Architectural Design text chapter 17 * Exam notes M2 due
Feb 11 Guest lecture: code navigation with Daniel Germán
Feb 14 Project & assignment working session A1 due
Feb 18 Reading Week
Feb 21 Reading Week
Feb 25 Midterm Midterm
Feb 28 Documenting behavior SEI behavior tech report
Mar 4 API and Interface documentation. Interface documentation
Mar 7 Technical Debt and Metrics my Field Study of TD metrics and TD M3 due
Mar 11 Evaluating Docs Guidelines for AD reviews
Mar 14 Architecture analysis ch 21 M4 due
Mar 18 Documenting Ops
Mar 21 Doc Exercise in class M5 due
Mar 25 Microservice styles; the latest research
Mar 28 TBD
Apr 1 Project presentation Groups tbd
Apr 4 Project presentations Groups tbd
Apr 7 M6 and M7 due in repo
Apr 12 Grad assignment due

Syllabus

Software is a long-lived and complex thing. This course is about understanding software in the large. We use the SEI text as a framework for understanding large-scale software systems. Topics include

  • what is architecture? Who are architects?
  • what structures are important to understand?
  • views on software systems
  • software quality attributes
  • architecture analysis and recovery
  • architecture-driven design
  • agile architecture
  • design, architecture, and technical debt

(the official course syllabus is distributed via HEAT (SENG480a link))

Recommended/Required Text:

SEI Software Architecture in Practice, Len Bass, Paul Clements, Rick Kazman. 3rd Edition. 2013.

Other texts

  • Design It! From Programmer to Software Architect, by Michael Keeling, Pragmatic Programmers 2017.
  • Just Enough Software Architecture, by George Fairbanks, Marshall and Brainerd, 2010.
  • Documenting Software Architectures, by Paul Clements et al., Addison-Wesley, 2011.
  • Designing Software Architecture, A Practical Approach, by Humberto Cervantes and Rick Kazman, Addison-Wesley 2017.
  • Software Systems Architecture: Working with Stakeholders Using Viewpoints and Perspectives, by Nick Rosanski and Eoin Woods, Addison-Wesley, 2011.
  • Applied Software Architecture, Christine Hofmeister, Rod Nord, Dilip Soni, Addison-Wesley, 2000.
  • Essential Software Architecture, by Ian Gorton, Springer, 2011.
  • Software Architecture: Perspectives on an emerging discipline, Mary Shaw and David Garlan, Prentice-Hall, 1996.
  • Architecture of Open-Source Applications, Amy Brown and Greg Wilson, eds. http://aosabook.org

Past versions:

Instructors

  • Neil Ernst, instructor. Office ECS 560, office hours after class Thursday or DM me.
  • Omar Elazhary, teaching assistant

Course Overview

After the course, students are able to:

  • begin to reason about and evaluate software design tradeoffs
  • capture software architecture in modern documentation approaches
  • work together in teams, with modern software tools.
  • use a views and beyond approach to capture software architecture.
  • compare and contrast different architectural styles, including product lines, microservices, MVC.
  • explain and recognise technical debt.

Deliverables

The class will use Github and Slack to work on the project. Students will have to register their Github username (either a permanent one or a throwaway) with the instructors. Those with an objection to using Github please contact the instructor for workarounds. All Github activity is private to the class organization. Please see the privacy notice on the Connex site.

Slack will be the primary mechanism used for communication in the class. My rationale (apart from being tools used in practice) is to expose the class as a whole to questions about projects, assignment, and lectures.

University and department policies on professional conduct and integrity are applicable. In particular, sexualized violence and harassment will not be tolerated. Feel free to see me in person, or via UVic email, for personal questions.

Overview

The final mark is weighted as following:

  • 15% assignment,
  • 25% midterm
  • 10% participation,
  • 50% substantial group project

Participation

Participation is worth 10% - demonstrated by:

  • activity on Slack,
  • contributions (and attendance, natch) in class.
  • Send Slack and Dr. Ernst a reading on software architecture and software comprehension. This can include blog posts, lengthy twitter chains, new books, Youtube videos, or podcasts.
  • Participate in the in-class exercise, optionally as part of the study.
  • Participation in the project is marked separately.

Assignment Undergrad

Undergrads: One individual assignment worth 15% of final mark. Due date as above.

For some project on Github, pick a quality attribute, create a (fully developed) quality attribute scenario, and document how the project source code realizes this scenario. Provide discussion on how the project can handle changes in this scenario in the future.

Details are in assn1.md.

Assignment Grad

Value: 15%. Due end of term, as shown above.

Details are in assn2.md.

Choose a current problem in software design or architecture. Suggestions are in the handout. Then do either a research or engineering project.

Group Project

The primary deliverable is a group project. You and your team will select a software project (OSS on Github/Bitbucket), and document important views on the software. The end result will be a set of documentation about the software system and a deep understanding of how it is constructed. 50% of final mark. Students will be assigned to teams and document an open source software system. Due dates in calendar below. See the Project outline.

Nota Bene: your individual mark in the project will be adjusted, possibly significantly, based on instructor assessment of your effort and peer reviews.

Midterm

One midterm, worth 25%. Scheduled for Feb 25.

Final

No final.

course's People

Contributors

neilernst avatar stvhwrd avatar zevisert avatar colinwerner avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.