Dienstag, 11. Juni 2019

Architecture decision record (ADR)

In a side note of a podcast I found the topic "Architecture decision record (ADR)".
The blog-post of thinkrelevance "Documenting Architecture Decisions" gives a very good motivation about why you should care about this topic and what ADRs are.

I'm on the same page that it makes sense to write ADRs into the repository for open source projects. Maybe it is also true for an enterprise company. But I think it maybe easier to start with wiki/confluence articles in that environment - especially one pro is that you can use images and not only text.

Further I found this github-repro, which provides an overview and some templates. But for me it looks like that it is a good advice to start with the simplest version of Michael Nygard, because for me is the argument that it should be a "short text file" important, because it shouldn't take much time to get the point of the decision and why it was made.

Sonntag, 9. Juni 2019

DevDocs.io central API Documentation

I found a helpful resource that offers the API of different languages, libraries and frameworks in a standardized form and in one (web-) tool:
https://devdocs.io

Because you can load a selection of APIs into the browser's offline cache, the tool has a very fast response time - even if the web page is not available (e.g. if you are sitting in a lane with a poor Internet connection). If you want to search something in CSS for instance, just enter CSS, press tab and enter the search phrase.

It is really worth to take a look at it. Also take a look into the preferences - it allows to enable a dark theme ;)