Algorithm Process Flow docs: 5 things to fix

Process flow docs are one of the very first things we look for when starting an algorithmic system review.

Especially when in graphic form, they help us understand where data comes from, what happens to it, and how decisions are made. We can then see the scope of the system and where we need to focus initial efforts.

Every once in a while there’s no docs at all. This is the extreme case. There’s usually something available, but we rarely get what we need. So we end up putting our own drawing together, and use it for the review and for the report.

Here are five things we often come across that would be a good idea to fix:

1. Piecemeal: aspects of the system are documented, others are left out. Very common, especially when (like most systems), components are designed separately and then brought together, or workarounds are put in place later.
2. Out of date: surprisingly common. How often to update? At least once a year, if not more often. Even systems that we think aren’t changing will have some form of upstream change or platform change, etc.
3. Too high level: not enough detail to see where the potential gaps are.
4. Too detailed: no high-level view, it’s all code or technical detail. Can also be difficult to maintain.
5. Words only: sometimes there are no graphics or pictures. Not very common, but we see it often enough that it’s worth including here.

Fixing only these 5 can move the needle a fair bit.

There are a few other things that can also help. For a future article.

Disclaimer: The info in this article is not legal advice. It may not be relevant to your circumstances. It was written for specific contexts within banks and insurers, may not apply to other contexts, and may not be relevant to other types of organisations.