Pre-publication checklist

[amadeuspzs]

Must have:

• [ ] Permissive Open Source Licence, for example: MIT Licence
• [ ] Documentation: high-level overview
• [ ] Documentation: model selection
• [ ] Documentation: installation and user guide
• [ ] Code: file input validation
• [ ] Code: legible and explainable
  • [ ] Sensible variable/function names
  • [ ] Complex code must be commented
  • [ ] Indentation follows accepted practice
• [ ] Code: modular
• [ ] Security: no data shared (public data linked by URL)
• [ ] Security: no serialised models
• [ ] Security: no secret keys
• [ ] Web UI: implements NHS.UK frontend

Nice to have:

• [ ] Code: automated linting e.g. PEP8
• [ ] Data: test (synthetic) data available

Final check:

• [ ] Comms team signoff

[amadeuspzs]

Supplier requirements:

Source code is to be accompanied by markdown documentation to include:

• High level overview of project and approach, including known limitations and issues.
• Licence review for included open-source components.
• A basic user guide to install and execute the tool.
• Rationale behind modelling approach and performance metrics.
• Data pipeline for transforming input data. This should include a data dictionary and could be in the form of a visual data transformation pipeline, adhering to GDS/code standards as per DTAC
• End-to-end integration test with fake data.
• Overview of the codebase structure.
• A preview of the codebase approximately two thirds of the way through the commission, ahead of the full code release.
• Code walkthrough sessions with the code preview, and final code handover.
• Recommendations to the NHS for implementing the solution, including metrics for monitoring performance.
• Recommendations to the NHS for further developing the solution.