...
All code should be documented and should describe not only how the software should be used and deployed abut also some architectural guidance to assist someone looking at the code for the first time to understand what the code is trying to do and how it is trying to do it. Background as to how the code fits into a bigger system or why the code is required is also helpful. The aim of the documentation is to provide the information required for someone to update/correct/further develop the code as quickly and easily as possible.
When using libraries for our software we should identify if the library is well maintained/tested/suited to production use. Adam Johnson has come up with a a suggestion of how this assessment could be made (https://adamj.eu/tech/2021/11/04/the-well-maintained-test/) which has been converted into a simple click app by Ryan Cheley (.https://www.ryancheley.com/2021/11/22/the-well-maintained-test) We would do well to follow these guidlines to ensure the libraries we use are suitable.