Tag

software

Documentation

Why you should have release notes

Building software is exciting. You get your first release out there, rock back your chair or celebrate with your team and overall everyone is happy. The word goes out and people start using what you’ve built. Exciting! Like any living software, you start improving your software and fix some bugs. There are a few times where I am looking at software (may it be a full blown application or plugins), I see that a new version is out, but I don’t see what has been changed. I also often come across releases where the major version has changed. As per semver, a major version means that one makes incompatible API changes. However, do developers really do follow that? Some may want to…

Read more
February 22, 2017 | by Dominique St-Amand | 2 Comments
Software Architecture

The importance of good logging

Lately, as you may have noticed through my other posts, I’ve been doing a lot of migration and DevOps. I’ve had my fair share of problems and the fact that I was able to skim through the logs for clues helped me put everything into production. I want to discuss in this post the importance of good information logging whether it is general information for the user or errors occurring in the application. Often we see applications not having any logs or the logs they provide are poor in content. Every system is different; not every system is configured the same way and/or has the same applications installed. Here are some points that should be followed by every developer when it comes…

Read more
February 6, 2017 | by Dominique St-Amand | 2 Comments