Almost every project has recurring operations consisting of several steps. The problem when there’s a lot of steps is that you have to know them by heart otherwise your project may become inconsistent and can lead to unexpected behaviors. Typically, developers save checklists files or screenshots of configuration settings on their local drive (like I did) to be sure they remain consistent and they don’t forget steps. So why not just sharing that precious knowledge with the team ?
Very simple : just create a Checklists.txt file at the root of your project (e.g. the backend project). As it will be source-controlled, any developer can add his contribution : add new checklists, complete existing ones or correct them.
Image may be NSFW.
Clik here to view.
Here’s an example on how to organize that file :
Image may be NSFW.
Clik here to view.
Enforcing that practice also ensures faster adoption of code base for new developers as it will act as a mini tutorial of the most important operations on your project !
