There are many things that can (and will) go wrong in data science applications. Unfortunately it's not just technical issues, often ethical issues will also appear. It would help if people had a checklist of things might go wrong. Enter deon.
You can write your own checklists too. Here's an example of
checklist.yml file that can be used to create a custom list.
title: Custom Checklist at Custom Company sections: - title: Legal section_id: F lines: - line_id: F.1 line_summary: Has legal checked it? line: Always to be sure we need a signature from legal. - line_id: F.2 line_summary: Will legal re-evaluate? line: Sometimes legal will need to re-evaluate the status once a year. Did we confirm? - title: Other Teams section_id: G lines: - line_id: G.1 line_summary: Influence on other Teams line: Our project might have an affect in other teams. Did we check? - line_id: G.2 line_summary: Dependency from other Teams line: Is it clear what teams we depend on? Do the other teams know this?
You can append this file to the existing file by running;
deon -o checklist.md --checklist checklist.yml
But you could also create a new file by running the same command on a new file.
deon -o custom-checklist.md --checklist checklist.yml
Feedback? See an issue? Something unclear? Feel free to mention it here.
If you want to be kept up to date, consider signing up for the newsletter.