Project processes
Note; This documentation was originally written with support handover in mind. This should be expanded upon though, and it is intended to be brought into the main project documentation that LF is working on.
Requirements
Support point-of-contact
This is a member of the Agile Collective support team. As part of the project team selection / assignment a support point of contact needs to be chosen and informed.
This will help ensure smooth handover, and prevent issues being raised too late.
Who is responsible?: The PM when choosing team or when starting project
Pull Requests of Documentation
Project specific documentation should live in the project repository in the docs directory (eg. https://gitlab.agile.coop/rise/rise-d8/-/tree/master/docs). Changes to these docs should be PR'd by the support point-of-contact. This time should be billable to the project.
Who is responsible?: The developer of the given feature.
Automated testing
There must be a file at /docs/testing.md which either explains the testing that has been setup, or at the very least explains why we did not write any testing
Support Handover Checklist
When a project is handed from the project team to support, they will check the below things are completed before approving it:
- [ x ] Support point-of-contact
Was there a support point-of-contact? They should be named in the README.md file with the project team details to help know how to get in touch with
- [ x ] Documentation
Are there usable project docs in a /docs/ folder (or at least a suitable overview in a root README.md file) - these should have been PRd by the point-of-contact during build
- [ x ] Automated Testing
There must be a file at /docs/testing.md which either explains the testing that has been setup, or at the very least explains why we did not write any testing
Support Point of Contact
A kickoff and monthly touching-of-base meeting should ideally happen with the support contact, they can then raise areas where they would like particular attention for documentation and handover.
Who is this?
This is someone on the support team who can oversee and help with the process of readying the site for support.
What do they do?
They review and can help with documentation and relay information to the support team. E.g. on BISA, the project team contacted support, we set up Dario as the PoC, and then ended up training him, contacting the previous maintainer, and also taking on other INDICO projects.
How do you set one?
Contact Luke in the support channel on rocket, or if he is not around just ask in the rocket channel and see if anyone bites.
Notes
- Where possible write automated tests : (even basic ones) for every custom feature as standard
- Documentation is vital for support : do not let it get forgotten due to budgets
Steps when creating a new project
- [ x ] Use an AC Starter kit (where possible)
Use one of our starter kits if one exists, this will get all required tooling setup and ready to use
- [ x ] Initial project docs
Configure the docs folder with some 'new project' data (eg. people, dates, figma links)
Last updated: