PRACTICAL GUIDE

Project documentation template for students

Use a short summary first, then give a reviewer enough detail to understand the work. Keep every claim tied to something you can explain.

Project in two sentences

Name the audience, task and actual outcome. Separate a working feature from a future idea. Avoid calling a prototype a launched product if it has not been deployed.

My contribution

List the concrete pieces you designed, built or tested. Name reused templates, tutorials, datasets and team contributions. A repository link alone does not prove authorship.

One decision I can defend

Describe an alternative, your choice and its tradeoff. For example, browser-only processing reduces server data collection but does not create cloud backup or collaboration.

Tests and artifacts

For each important claim, record the test procedure, environment, result and artifact. Include failed tests and fixes. Use dated screenshots or logs when a live link is unavailable.

Limits and next steps

State unknowns, missing checks and the next small improvement. Do not invent user feedback or numerical impact. A limitation is part of the evidence, not something to hide.

Safe sharing and setup

Respect licenses, consent and agreements. Remove secrets and identifying details; get permission where required. Include reproduction steps and clarify whether links are public, private or unavailable.

Build my evidence pack