Some time ago I saw an information about new StackOverflow section named Documentation. At the very beginning, I was very excited about this new feature. It sounds great to structure and organizes all the knowledge contained into this portal. Every day thousands of developers contribute to growing this one of the world’s biggest knowledge base. It is a great goal to achieve. However, when I started to look carefully at the content and the form of the knowledge in this documentation I realized that I even don’t know what good documentation means.
Some times ago I faced a task to write tests for generic classes. In the simplest approach it is quite easy task. If we want to test this class using for example NUnit library we can simply write a few test cases.
Integration test is used for checking the behaviour of application from interface to the database. In our case it will be used with API. It is most useful to:
– testing if correctly operate on data
– perform smoke test (checking if some part of API is working)
– simulate some types of behaviour on API server
One of the task during my work on AppSensor .NET library was to create a simple implementation of log provider. It was my inspiration to make some research about rules how to create a good logging system.
The first thing that is necessary before creating or even configuring is to think what is the purpose of logging. When we might need this information and how it can be useful for future application use.