In a recent episode of Paul’s Security Weekly, an off-hand comment was made about documentation: you shouldn’t merely document what to do, nor even why, but also what you tried that didn’t work (ie, augment the status quo).
This is similar to a famous quote attributed to Edison,
I have not failed. I’ve just found 10,000 ways that won’t work.
In light of my recommended, preferred practice and policy of “terse verbosity“, I would strongly suggest not placing the “doesn’t work” in-line, typically. Instead, put footnotes, an appendix, etc. But always
explain everything you did, but use bullet points if possible, rather than prose form
Loads of other goodies in that episode, too – but this one jumped-out as applicable to everyone.
Also published on Medium.