Building Software Together

Chapter 1: Introduction

If you are an undergraduate embarking on a team software project, this book will give you the tools you need to succeed. Some of these are purely technical, like version control system, while others are social: how to form teams, manage people who aren't pulling their weight, cut features when time runs short, and understand who owns the things you produce.

Our aim is to teach you how to be a compassionate programmer: one who cares as much about the well-being of their colleagues and users as they do about their own. This focus is not entirely altruistic—everything you do to help others also helps your future self—but now that we know how much harm software can do, we need to learn to build it in better ways.

Topics

Life is short and your project is even shorter, so this book focuses on the things that will help you the most in the short term:

We have included other material as well, since there is a lot of variation between project courses and even more between the people doing them. Throughout, we are guided by a modified version of Dobzhansky's Rule:

Nothing in software engineering makes sense except in the light of psychology.

Many of the hard problems in software engineering stem from the fact that our mental capacity is limited, which means we have to design programs so that they will fit into the space between our ears. In addition, we learn and work better when we are doing things that help us meet our personal goals, which means projects will be more successful if we take motivation into account.

Audience

Every lesson should be written with specific learners in mind. These personas describe ours:

Like these personas, readers should:

This book can be read on its own or as a companion to Software Design by Example, which teaches the basics of software design by showing you how to build the tools you program with. If you are looking for a project to do in a course, adding a tool to those covered there would be fun as well as educational.

Using and Contributing

All of the written material on this site is made available under the Creative Commons - Attribution - NonCommercial 4.0 International license (CC-BY-NC-4.0), while the software is made available under the Hippocratic License. The first allows you to use and remix this material for non-commercial purposes, as-is or in adapted form, provided you cite its original source; the second allows you to use and remix the software on this site provided you do not violate international agreements governing human rights. Please see Appendix A for details.

If you would like to improve what we have or add new material, please see the Code of Conduct in Appendix C and the contributor guidelines in Appendix D. If you have questions or would like to chat about using this material in a course, please file an issue in this site's GitHub repository or send us email.

Acknowledgments

This book is dedicated to Marian Petre, who taught me that not everything worth studying can be measured, and to Tom Wilkie, who taught me how to turn a thousand words I'd written into a hundred someone would actually want to read. I am also grateful to all of the students who have done projects with me over the years.

I have tried to base recommendations on empirical software engineering research (Chapter 22) and on the science of teaching and learning (Appendix F). Where those don't have answers, I have drawn on the experience of the students and programmers mentioned below. Any errors, omissions, or misunderstandings that remain are entirely our fault.

[Sholler2019, Wilson2019, Irving2021, Smalls2021]; I'm grateful to Taylor & Francis, PLoS, and my co-authors for making available under open licenses. I would also like to thank David Graf for doi2bib and Alexandra Elbakyan for Sci-Hub: this book would have been much harder to write without their idealism and hard work.

All proceeds from this project will go to support the Red Door Family Shelter.