Reading view

How to make Documentation Discoverable?

Hey, DevOps Engineer here!

How do you handle the problem of “there is documentation” but no one knows where it is (except like 2 seniors who were there when it was written) - Using Confluence for this example?

The goal is to make the documentation explicitly available where it is most needed, instead of having to ask someone else “Where are the docs on X?” The reason this matters is that if someone is sick or unavailable, we avoid a single point of failure :D

Ideas I’ve come up with:

  • Add relevant documents to the Jira ticket (for example, deployment Guide attached to deployment tickets).
  • Create “Hook Pages” that are framed around the problem and point to or include the guide for example,
    • “How do I do X?” → links to guide on X
    • “What is Service?” → links to “Service Architecture Explanation Guide”
    • One guide can have multiple problem/question hooks

How do you go about making your docmunetation easily findable when you need it?

submitted by /u/Sebastan12 to r/devops
[link] [comments]
❌