Answer with docs

As someone who works in an enablement team, I’m trying to instil a best practice of answering with docs. This has a number of benefits to both us and our users:

  • It ensures our documentation is constantly improving and being kept up to date

This means when a question comes in via Slack or otherwise we try to answer by linking to the documentation. If there isn’t any, first write some up and then use that as the answer. This should apply to our internal documentation and our own runbooks.

I’d be interested to hear if anyone else has tried something like this and how successful (or otherwise!) it’s been.

Originally published at https://andrew-jones.com/blog/answer-with-docs/.

Cover image from Unsplash.

--

--

Principal (Data) Engineer. Coined Data Contracts. Writing about data quality, data mesh, data engineering, etc. and how to get the most value from your data.

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store
Andrew Jones

Principal (Data) Engineer. Coined Data Contracts. Writing about data quality, data mesh, data engineering, etc. and how to get the most value from your data.