Archive for October, 2018

Home » October 2018

Blogumentation

I'm not sure if he actually came up with the term 'blogumentation' but software quality engineer Jamie Tanna features quite prominently when searching for it so at the very least he appears to be one of its more avid and deliberate users. Anyway, while the term 'blogumentation' might be somewhat obscure the concept behind this particular portmanteau is a seminal one. Basically, it derives from the insight that often the best way to learn and internalise knowledge is to talk, write and ... Read more

The 5 Levels of Logging Explained by Orhan Kavrakoğlu

In this article Orhan Kavrakoğlu explains the logging levels commonly used in software alongside with some pertinent examples as well as recommendations and best practices such as in which case to use which particular log level and how to present them to the target audience (i.e. other developers, system administrators or DevOps people) so they get noticed in accordance with their respective importance and urgency. As mentioned here before seemingly trivial improvements such as providing better context in your log messages can ... Read more

Artur Śmiarowski’s Guidelines for Writing Readable Code

Code means communication has become a bit of a mantra for me. Source code isn't just the means by which you translate requirements into commands and structures a machine can understand. Source code also communicates your intent as a designer and engineer as to what a particular piece of software is supposed to do. If written in a clear and comprehensible manner code can serve as an authoritative design specification with no or little extra documentation needed. I would go as far as ... Read more

Tool Suggestion – NGD: Angular Dependencies Graph

When working on a larger codebase knowing about the dependencies between components is crucial, particularly so when you're trying to understand how an existing application works. NGD - Angular Dependencies Graph (part of the Compodoc documentation suite for Angular) is a tool that - as the name suggests - generates dependency graphs (i.e. boxes and arrows) for Angular applications. Dependency graphs give you a high-level overview of an application's architecture and hence are a great first step in understanding how an application ... Read more