uchicago-cs / student-resource-guide

UChicago CS Student Resource Guide
BSD 3-Clause "New" or "Revised" License
10 stars 5 forks source link

Initial version of the developer guide #1

Closed borjasotomayor closed 4 years ago

borjasotomayor commented 4 years ago

This is an initial version of the CS developer guide. Ideally, it will eventually become a guide that can be shared across multiple classes but, for now, it's written mostly with CS 220 in mind.

Feel free to comment and suggest changes on any part of it, but here are a few things to look out for:

borjasotomayor commented 4 years ago

So, regarding the "Working in Teams" section, the goal is for this guide to eventually be shared by multiple classes (I plan to eventually use it in both CS 121 and Networks), so I was just starting to adapt the "Working in Pairs" document from Networks to be more generally applicable to other classes.

However, I can see this section being confusing to CS 220 students. Maybe we should just include a warning box at the top of the page that tells them that the page doesn't apply to them? (and that, while there may be some advice they may find useful, they shouldn't read it as a set of "rules" for how to work collaboratively in this particular class).

dwahme commented 4 years ago

I think that the working in pairs section is good, but I wouldn't treat it so much as a warning for 220 students to "ignore." I think that they should be aware that it's focused on how to work with another student on a project, not working with a team overall (and the titles for the section should probably be updated as such).

Maybe something along the lines of "This section is about how to work closely with another person on a task or extended project. Some principles will extend to working on a larger team, but is not the primary goal of this section. See for tips on working in a larger software team."