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,
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