Code docs that make sense - part II

Code docs that make sense - part II

1st part of this post can be found here. Document your API - Swagger Ok, doctest was for Elixir & Python. Many other languages / platforms have similar mechanisms at the various stage of maturity, but things get even better once you focus on documentation of your public API, especially if you're using open standards - like RESTful services or WS. In such a case, you've plenty of solutions to choose…

Code docs that make sense - part I

Code docs that make sense - part I

I've written many post concerning writing code this way or another. Same applies to writing tests - all kind of tests you can possibly imagine. But there's one kind of software development process output I've been notoriously avoiding: documentation. This topics is bit touchy - we all know the most popular statements / opinions regarding documentation these days: Clean code doesn't need documentation (AKA self-explanatory code) Interface(s) should serve as…

Keep fingers crossed for BDD

Believe it or not, we’re trying to introduce BDD (Behavior Driven Development -¬†http://en.wikipedia.org/wiki/Behavior-driven_development) using automated tests on the large web front-end implementation project (based on .NET and heavy JavaScript). And we’re doing it, because actually these are the client people who came to us and told us that they are more than willing to try explicitly that and they&…