Documentation of how to use the template

[c-martinez]

Checklist before submitting an issue

• I have checked the existing issues and couldn't find an issue about this bug.

Issue details

During the research software templates session in RSECon24, there were several comments in the mentimeter which I have interpreted as related to having really good documentation.

Documentation should be very clear on how to use the template, specially if it is the user's first time using any kind of template. It should keep in mind the level of expertise of the user (thinking of personas might be useful for this).

It should also explain why specific practices are used (or point to further reading). Ideally a tutorial / training materials would be available.

Mentimeter comments were along the lines:
Usefulness depends on initial learning curve;
Needs to explain WHY each feature is useful and included to avoid "too long, didn't read/use";
Explain clearly all components within the template, it's good to know why something is present as opposed to using it blindly;
Really good documentation, training, frequent review of the template would encourage people to use this template

[bouweandela]

Example of a well documented template: https://github.com/scientific-python/cookie comes with a guide https://learn.scientific-python.org/development/