Documenting Data Cartoons

New Year's Resolutions

New Year's Resolutions

Let's welcome New Year! Another year we'll ignore our resolutions.

Simplified Data Lineage

Simplified Data Lineage

When you are reverse engineering a system it's good to start with something simple. That will help you see the big picture. Then you can get into more details.

Documentation on a Hunt

Documentation on a Hunt

None of us reads manuals, right? But having them with you might get handy.

Hunting, Gathering & Recruiting

Hunting, Gathering & Recruiting

Documentation is blessing when you want to hire new people to your team. Any kind of documentation. And that was so since the dawn of time.

Just a small system update

Just a small system update

Do you know this that feeling of guilt that after phase of the extensive analysis, design, and implementation, you apply last minute changes or fixes without a trace in the documentation?

Team spent countless hours on documentation of requirements and the design, and just like that it becomes out of date and loses its value. And only because there was no time, budget, processes in place, or someone was just lazy.

Do you know that feeling that after a while of the release you have no idea how this system is supposed to work?

Well, the solution is quite simple, and yet so hard: keep your documentation up to date whenever system changes. Easier said than done.

Documentation room

Documentation room

But at least they have a documentation room. Do you? A shelf? A folder? Anything?

Will document for cookies

Will document for cookies

Documentation is very important part of development. You need to find ways to motivate developers to deliver it along with code and designs. You can be creative.

Hunting, gathering & documenting

Hunting, gathering & documenting

If cavemen did not decide to document their processes would we have Internet and mobile phones today? I think not. Start documenting your processes today if you haven't already. Document your data.

We need a bigger office

We need a bigger office

Creating a diagram for many databases can be a real challenge. Including space required. Our solution - create a number of smaller diagrams.

Let's document!

Let's document!

Documentation is that thing many people and teams give up on doing or don't plan in the first place. It is the strategy of following the path of least resistance. Documentation is something often not required immediately, but it’s always valuable in the long run.

Documentation included

Documentation included

Customers ordering software don't see this as a separate item that requires work that they need to pay for separately. They often require it as a given.

Lots of data. No way to find it

Lots of data. No way to find it

Imagine a wall of unlabeled folders and you need to find the right one. You'd need to go one by one and look inside. Meaningless names of tables in a database can be such folders and finding the right table requires to go one by one.

Check in the documentation

Check in the documentation

There are tools for documentation generation, but without meaningful descriptions this documentation can be useless.

Subscribe weekly cartoon Use cartoons