Documentation

Rotterdam loading weather… Sicily (Catania) loading weather… From the Maas to Mount Etna: about 1,800 km as the crow flies
← All services
Services

Documentation

Good documentation makes sure your organisation keeps understanding and managing its own data solution, even when the developer leaves. But documentation can also slow development down if it is used the wrong way.

From practice

In 1996, during a graduation project at Philips, I was asked to stop documenting according to the SDM method and simply start building. Even then it was clear that involving the customer as early as possible matters, for example with a prototype. Today we call that Agile.

Agile and proof of concept

  • Agile: developing in short sprints, built on simplicity, communication, customer feedback and collaboration.
  • Proof of concept (POC): an early version to test whether the wishes and requirements are feasible, from sketch or wireframe to working prototype.

What we document

  • System architecture: the design and how the parts fit together.
  • Data model and data dictionary: which data exists and what it means.
  • Data flows: from source to report.
  • Operations manual: how the solution is loaded, monitored and changed.

Just enough to manage it yourself, without slowing development down. No documentation at all? Then it starts with reverse engineering.

Get more out of your data?

Get in touch for a no-obligation introduction.

bi-Wooning B.V. · Data warehousing, BI and Sat-Impactcheck · About bi-Wooning Chamber of Commerce (KvK) 90678370