End-to-end high level design

[pritchardians]

Create an end-to-end high level design to show the flow of data and the logic. High level = each component will be designed individually.

Acceptance Criteria

• High level design document showing how a request is processed and a response generated
• Break out work into components (probably functions, not objects) that are expressed as issues in this project
• Determine and document how to pass data between components (such as candidate scores, warnings etc.)
  • For each element in the request (comparator attributes) and response (scores, ranking, warnings) work out how to pass data from component to component without any global variable mutation if possible. Tricky!

[pritchardians]

@jasonwpacker - I see you created a docs folder for the design docs. Cool! This supersedes the _design directory I created earlier. Please could you look in there to see if there is anything you could use? I had just put in a note or two...

[jasonwpacker]

I've uploaded some documentation but am interested in your take on what the data flow diagram might look like to be the most useful.