Tech Docs

Tech Docs Overview

Tech Docs is based on a docs-as-code approach. We think encouraging developers to write their internal docs with the same tools they use to write code is a much better developer experience than asking them to use Confluence or Notion.

The other great part about Tech Docs—once your git repos are linked to services in your OpsLevel catalog, zero additional configuration is required. Markdown files will be automatically imported from git and rendered in OpsLevel.

In addition to importing and rendering, all your docs are automatically searchable from within OpsLevel. Developers don’t have to remember what repo to open up in order to find information or answer questions. They can just use the search bar in OpsLevel.

For developers, not much is more frustrating than trying to work with another team’s service and finding that the docs are incomplete or non-existent. Bringing Tech Docs into OpsLevel lets engineering leaders address this poor developer experience and start driving documentation improvements.

For example:

• Write a Repo File or Repo Grep check to verify the right markdown files and content are in repos.
• Want to make it a top priority? Run a campaign!