Documenting code
Documentation is the holy grail when maintaining a code base. This should sound familiar; how often have you found yourself reviewing or having to work with a new code base, and there is little to no documentation on how things work? It is every engineer’s nightmare in this field of work. When we talk about documentation, we not only talk about code comments or technical documentation but also conceptual documentation that describes what certain code does on a higher level.
In fact, as mentioned in the book Docs for Developers: An Engineer’s Field Guide to Technical Writing (https://docsfordevelopers.com/), we can distinguish between several types of documentation:
- Code comments
- READMEs
- Getting started
- Conceptual documentation
Let’s talk about each of them in detail.
Documenting code in dbt
As an analytics engineer, we recommend several handy tools for documenting your code. Tools such as dbt allow you to place...
