The checklist
https://developersociety.github.io/catalysthandover/
-
You’ve met the Definition of Done as stated in your Catalyst agreement. -
You’ve given a final demo of the solution you’ve developed to your charity -
You’ve shared any final design assets (e.g. wireframes, user research personas, click through prototypes) through Ochre, or in the repository -
You’ve shared the source code repository with Catalyst -
You’ve shared your QA/Testing scripts with Catalyst connector, or the tests live in the repository and how to run tests is explained in the documentation -
You’ve applied an appropriate Open Source license to the source code repository (LGPL preferred) -
You’ve made sure that the repository has no secrets or keys in current or previous commits -
You've created an OpenAPI spec for the APIs you've built in the project, stored in the repository -
You’ve created externally facing markdown documentation and included that in your repository -
You've added to the documentation how to install/spin-up a local instance of the solution, in steps a junior developer could follow. -
You’ve created clear documentation for spinning the solution up in staging and in production -
You've written common use-case examples of using any APIs you've built into your documentation -
You’ve taken note of any existing bugs and included them in your handover documentation, ideally creating issues in the repository -
You've documented how users are able to leave feedback or create issues -
You’ve created a list of current software dependencies in the documentation, referencing links to install documentation for those dependencies -
You’ve outlined any third-party dependencies and ongoing costs to maintain the solution developed in Ochre -
You’ve created a roadmap outlining clear next steps for the project as a backlog, ideally alongside the repository, shared via Ochre
Edited by Finn Lewis