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
  • It trains users to look in the docs first, before asking, allowing them to self-serve
  • It reduces future toil

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.

--

--

--

Software engineer and tech lead. Enjoy solving problems and getting things done. Always looking to learn and improve.

Love podcasts or audiobooks? Learn on the go with our new app.

Recommended from Medium

Citrix ShareFile FTP Alternative

citrix sharefile ftp alternative

Clean up the type of time that programming needs to know

Prometheus/Cortex remote write using Java

Containers, Kubernetes & Continuous Delivery/Integration in AI

2021 State of Chaos Engineering

What is EIGRP ?EIGRP- Enhanced Interior Gateway Routing Protocol

Guide to make “Dataset of Straight line images using Pixels” with different Variations in “Python”

Migrating to Seagate Lyve Cloud

lyve cloud migration tool

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

Andrew Jones

Software engineer and tech lead. Enjoy solving problems and getting things done. Always looking to learn and improve.

More from Medium

What are virtual care providers, how do they differentiate themselves and what is next?

THOUGHT LEADER SERIES  USEFUL WAYS TO SUPPORT YOUR SALES TEAM  I have always wondered about the…

Replace any vehicle in GTA 5 | Lvl1 ∙ Part 2 ► Vehicle files and vehicles.meta

Web3 Newsletter — Edition #7