Skip to content
VirtuJudgePublic

About

a repo that contains any docs (md, pdfs, presentations) and diagrams we will use.

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

VirtuJudge documentation

This repository is the planning and design source for VirtuJudge. VirtuJudge helps teams practise a pitch, review measurable delivery signals, answer grounded follow-up questions, and receive evidence-linked team and individual feedback.

The current delivery target is a ten-day competition MVP. Production hardening and larger product ideas are recorded separately so they don't silently enter the MVP.

Start here

Source material

The proposal is the source of the product idea. The documents linked above resolve ambiguities in it and define the plan that should be reviewed before implementation starts.

Documentation rules

  1. Change the contract or decision document before changing behaviour.
  2. Keep diagrams and examples consistent with the written contract.
  3. Record hard-to-reverse decisions as ADRs.
  4. Run the documentation and contract checks before requesting review.
  5. Do not merge reviewed contract snapshots by hand when they can be generated from a service-owned schema.

About

a repo that contains any docs (md, pdfs, presentations) and diagrams we will use.

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages