- Overview on what the code do and expected output
- Project: project name (link to project in CRM)
- Contact: github account
- Input: directory, file types, file structure, source/where to download, link to data in Teams
- Output: directory, file types, link to output in Teams
- Structure: description of the main code and its function
- Setup (requirements: packages, python version, etc.)
Step by step e.g. how to call the main function, how to run
See example here.