The Good Documentation
It knows its systems and its systems know it.
I've spent the last two days in all-day work meetings, for Reasons. And although it's not my main thing any more, I got rather emphatic-more than once-about the need for good documentation. It became kind of a Thing. It may haunt me in the future.
And then I come home to this in my Twitter feed:
Does anyone know if there's a riff on Psalm 23:4 for technical documentation? I feel like this should exist.
- emma jane (@emmajanehw) January 27, 2016
Really, what's a pastiche-monger to do?
Well.
1The DOCUMENTATION is my guide; I shall not wonder.
2It maketh me to understand the necessary concepts;
It leadeth me through the installation process.
3It reassureth me;
It leadeth me on the happy path for my desired objectives.
4Yea, though I work through the advanced configuration menus,
I will fear no failures, for thou art with me
Thy FAQ and thy troubleshooting they comfort me.
5Thou providest examples to me in the context of mine use cases.
Thou explainest my expected outcomes.
My results are perfect.
6Surely good performance and stability will persist throughout the system life
And it will run within the parameters of the DOCUMENTATION forever.