Sample project documentation

Sample 265 project team documents

The documentation below comes from a fictional game project that followed a six-phase waterfall model (which may vary somewhat from the current term's SDLC), and since it's fictional, things like the names/email addresses/URLs aren't real.

Even though they're based on a 6-phase waterfall approach, they should still provide a reasonable example of the kind of information and level of detail I'm expecting from the CSCI 265 team projects.

The only documentation files you'll be submitting are the .md files, the various pdfs here are just included so folks can see the rendered markdown in case their browser is not yet configured to do the rendering.
The documents are also shown in the state I'd expect them when originally submitted, they'd be in a nicer/more complete state by the end of the project since by then you would have had time to apply numerous revisions.

Phase 1 (presentations in the week 3 lab)

Preliminary proposal (original markdown), rendered pdf version

Team charter (original markdown), rendered pdf version

Proposal presentation slides, Charter presentation slides

Sample individual contribution assessment (original markdown), rendered pdf version

Phase 2 (presentations in the week 5 lab)

Standards and processes (original markdown), rendered pdf version

Product requirements (original markdown), rendered pdf version

Phase 3 (presentations in the week 7 lab)

Project update and rendered pdf version

Suitable revisions to requirements.md, charter.md, and standards.md would also have been completed by this point.

Logical design and rendered pdf version

Phase 4 (presentations in the week 9 lab)

Project update document and rendered pdf version (I've put these in 'update4.md/pdf' files so I can keep both project updates posted here)

Suitable revisions to design.md, requirements.md, charter.md, and standards.md would also have been completed by this point, matching the updates listed above (or any missing revisions clearly noted in the relevant 'known issues').

Proof of concept document and rendered pdf version

Phase 5 (Test plan and files) (presentations in the week 11 lab)

Much like the previous phase, the revised project update document (update.md) would detail all the fixes and changes made to the charter, standards, requirements, and design since phase 4 was submitted.

The matching actual revisions/fixes to design.md, requirements.md, charter.md, and standards.md would also have been completed by this point.

The test data to accompany the test process would also be in place in the team repo by this point, including:

all scripts referenced in the document (whether user action scripts or actual executable scripts)
all directories and files containing the needed test data for each test case
any external servers (web servers, database servers, etc) that are needed to use the product will have been set up, configured, and populated with all needed tables/data
Each of the items above that are missing/incomplete should be clearly identified in the test document as a known issue

Still in development: hopefully you'll see incremental progress here
User Acceptance Test Process document

Phase 6 (demo and closeout) (in the week 13 lab)

A final project update (update.md) would be ready at this point.

Final versions of testplan.md, design.md, requirements.md, charter.md, and standards.md would also have been completed by this point.

The project demo will be the live in-lab demonstration of the final product.

Project closeout (wrapup)