IT Blog & Photo Gallery

Articles on 'documentation'

Should I Document This?

November 27, 2022

Documentation - a frequently avoided topic among software developers, for whom natural language is not always their favorite kind of language - "If you want to know how it works, just look at the code". Theoretically perhaps correct, because how the application works is definitely in there. But practically not sufficient, because the why - the intention behind it, the underlying decisions and possible implications or discarded alternatives - cannot be found there.