Project Handoff
Canvas is the source of truth for this term’s assignments. This page may already show changes Canvas does not have yet.
Within a few weeks, your team stops existing and the project keeps going: with your partner, a maintainer community, next year’s capstone team, or you. The handoff is professional knowledge transfer, and the bar is concrete: someone with relevant technical background who didn’t build it can run and maintain the project using only this document and the repository. If your living docs stayed current all year, this assignment is mostly assembly.
What You Produce
Section titled “What You Produce”A partner-facing handoff document (2 to 4 pages, delivered where your partner keeps project documents: their issue tracker, wiki, or document system, or the repository’s issues if they have none) containing the sections below. Student-proposed projects use their mentor or instructor as the confirming partner. A non-responsive partner does not tank your grade: after two documented attempts, an instructor or mentor confirms instead and the criterion is scored on your documented attempts.
AI use: AI may draft and assemble from your repository; that is what the living docs were for. Do not let it invent steps, links, or artifact locations: every command and URL in this document must work, because the person who discovers otherwise cannot ask you anymore.
1. Overview and Current Status
Section titled “1. Overview and Current Status”What the project is and what problem it solves; the current deployment or delivery state (is it running, where, how stable); what is and is not included in this handoff, with reasons; and a contact for each team member for follow-up questions.
2. Setup Someone New Can Follow
Section titled “2. Setup Someone New Can Follow”From nothing to running: prerequisites with versions, copy-pasteable install and build commands, how to run the tests, how to run a local development environment, how to deploy (or a pointer to the runbook), and the pitfalls you know about with their fixes. This should largely already exist in README.md and CONTRIBUTING.md; the handoff points at it and fills gaps rather than duplicating it. Verify it: have the team member who least knows the setup path (or your partner) execute it clean and fix what breaks.
3. Known Issues, Limitations, and Future Work
Section titled “3. Known Issues, Limitations, and Future Work”A prioritized accounting: open bugs with severities (link the tracker), features that are partial or fragile, technical debt and whether it was intentional, a prioritized backlog of future work, and every credential, API key, or access permission that must be transferred, with its transfer status, or a line saying there is nothing to transfer.
4. The Living Docs
Section titled “4. The Living Docs”Links into the repository’s living documentation, each confirmed current as of handoff: docs/requirements.md, docs/design.md, and docs/risks.md, plus docs/rfcs/ or docs/adr/ for the decision record. The successor team’s first task is an audit of what you left behind (the inherited-codebase audit lists what it covers), so write the handoff to answer that audit. The Repo Checkpoints kept those three current, and the forward-looking section of your Project Retrospective tells the successor how to read them. See the Documentation guide, and Diataxis if you’re unsure whether a given page should be a tutorial, a how-to, a reference, or an explanation.
5. Handoff Checklist and Partner Confirmation
Section titled “5. Handoff Checklist and Partner Confirmation”Complete this checklist in the document; unchecked items get a reason and a follow-up plan:
- Repository access transferred to the partner, kept by the team, or archived, per agreement
- Credentials and secrets transferred securely, none committed to the repo
- Deployment environment access transferred or documented
- Open issues triaged and documented
-
README.mdand the living docs current and accurate - Partner has confirmed receipt in writing
The written confirmation (quoted email or signed note, included in the document) must say the partner can access the repository, can run the project, and understands what maintaining it will take.
6. Release Consent and Archive Declaration
Section titled “6. Release Consent and Archive Declaration”The school may share project archives with future students and project partners as examples of student work; this is optional and separate from your partner’s rights to the software. Include a declaration listing every team member as Consenting or Not Consenting, note any NDA or partner restriction on sharing, and state where the project archive lives (the repository itself, or the agreed sanitized export if your project is under NDA). One dissent or restriction means the archive is not shared; the declaration is still required.
What You Submit
Section titled “What You Submit”The handoff document as one PDF, with the cover Submitting Your Work describes and the written partner confirmation from section 5 inside it.
Rubric
Section titled “Rubric”| Criterion | Ratings |
|---|---|
| Overview and status15 points | |
| Setup: complete, copy-pasteable, verified by a fresh runcomplete, copy-pasteable, and actually verified by a fresh run30 points | |
| Known issues and future work20 points | |
| Living docs linked and currentrequirements, design, and risks linked and current, decision record reachable10 points | |
| Checklist, partner confirmation, and release consentChecklist, written partner confirmation, and release-consent declaration all complete25 points |
Activities That Prepare This
Section titled “Activities That Prepare This”Planning for Maintenance and Long-Term Support for known issues and future work, and Describe your API Reference for the living-docs criterion if other code or people build on your product.
Examples. A project may match several rows or none. If none fits, ask your partner or mentor which activities do.
| If | Activities |
|---|---|
| some of your contributions to an open-source project are still unmerged | Software Release and Versioning: what you owe is the state of that unmerged work |
| the next owner has to get your results back | Make Your Artifact Reproducible. For a result, this is the handoff |
| the partner’s people will operate it after you leave | Planning for Maintenance and Long-Term Support. You graduate and the system stays, so for the partner the runbook largely is the product |
| people keep using it after you leave | User Manual |
Browse Testing, Release, and Handoff and Research Methods when these run out.