OpsLevel Logo
Product

Visibility

Catalog

Keep an automated record of truth

Integrations

Unify your entire tech stack

AI Engine

Restoring knowledge & generating insight

Standards

Scorecards

Measure and improve software health

Campaigns

Action on cross-cutting initiatives with ease

Checks

Get actionable insights

Developer Autonomy

Service Templates

Spin up new services within guardrails

Self-service Actions

Empower devs to do more on their own

Knowledge Center

Tap into API & Tech Docs in one single place

Featured Resource

March Product Updates
March Product Updates
Read more
Use Cases

Use cases

Improve Standards

Set and rollout best practices for your software

Drive Ownership

Build accountability and clarity into your catalog

Developer Experience

Free up your team to focus on high-impact work

Featured Resource

The Ultimate Guide to Microservices Versioning Best Practices
The Ultimate Guide to Microservices Versioning Best Practices
Read more
Customers
Our customers

We support leading engineering teams to deliver high-quality software, faster.

More customers
Hudl
Hudl goes from Rookie to MVP with OpsLevel
Read more
Hudl
Keller Williams
Keller Williams’ software catalog becomes a vital source of truth
Read more
Keller Williams
Duolingo
How Duolingo automates service creation and maintenance to tackle more impactful infra work
Read more
Duolingo
Resources
Our resources

Explore our library of helpful resources and learn what your team can do with OpsLevel.

All resources

Resource types

Blog

Resources, tips, and the latest in engineering insights

Guide

Practical resources to roll out new programs and features

Demo

Videos of our product and features

Events

Live and on-demand conversations

Interactive Demo

See OpsLevel in action

Pricing

Flexible and designed for your unique needs

Docs
Log In
Book a demo
Log In
Book a demo
No items found.
Share this
Table of contents
 link
 
Resources
Blog

Add more context to your developer portal with Tech Docs

Product
Visibility
DevOps
Platform engineer
Documentation
Add more context to your developer portal with Tech Docs
OpsLevel
|
January 5, 2023

Tech Docs from OpsLevel is the fastest way to turn siloed, internal service documentation into shared context that’s discoverable and searchable by your entire engineering organization.

With Tech Docs, all your internal docs stuck in markdown files scattered across repos can now live in your OpsLevel catalog—so context and search are built-in. 

And, if you’ve not yet fully adopted docs as code or want to raise your internal docs bar, we can help with that too.

Why are internal docs so frustrating?

Internal documentation is an ongoing struggle for most software teams, especially in our increasingly remote-first world. Research shows that a team of 50 developers loses 333–651 hours each week searching for information to solve problems.

Knowledge is spread across wikis, Google Docs, Notion, your team-specific Stack Overflow, and maybe even Confluence (don’t get us started on Slack or MS Teams). 

During product discovery, one OpsLevel user said:

Confluence is an abyss. There are docs in there a decade old. No idea how accurate they are.

Clearly, the current landscape of solutions has many different options with lots of bells and whistles. But the end result is knowledge fragmented across multiple tools, developers frustrated with user experiences that don’t suit them, poor adoption, and lost productivity.

Fortunately, there's an emerging new solution: docs-as-code. A docs-as-code approach to managing internal documentation solves major pain points around the developer-authoring-experience. Developers can write and maintain their docs the same way they do their code: with a text editor, git, and a remote repository.

For most teams, these UX upgrades have been worth sacrificing things like discovery, search, context, and the non-developer UX. But with OpsLevel’s new Tech Docs capability, teams can have their cake and eat it too.

The new Tech Docs search results tab

Tech Docs in OpsLevel

With Tech Docs, developers can continue authoring internal documentation via their existing docs-as-code workflows. Docs continue to live in repos as markdown files. But the docs consumer experience is radically improved. 

OpsLevel automatically imports, indexes, and renders markdown files from git repos linked to cataloged services.

So all OpsLevel users can now browse or search info that was previously siloed across hundreds of git repos—all within the context of your existing catalog. 

The new Tech Docs tab for an individual service

With Tech Docs in OpsLevel, internal docs consumers no longer need to think “where should I look?” before asking a question or beginning a search. It’s all at their fingertips.

Whatever the use case—high pressure incident response, new feature development, or standard operations—say goodbye to weeding through multiple sources of info to find the answers you need to get work done.

Trust but verify

Tech Docs lets consumers find internal documentation faster and view those docs in the context of your metadata-rich service catalog. But how much should users trust what they find? 

Of course, we can’t verify the accuracy of your internal documentation. But because we’re deeply integrated with your git repos, we can run Service Maturity checks against your docs.

A grep check verifying section headers in documentation

Want to verify that your docs all use consistent filenames, have the same section headings, or don’t contain any `TODO` placeholders? These examples (any many more) are easily implemented with Repo Grep checks. Once you’ve identified which services have internal docs gaps, you can run a Campaign to encourage service owners to take corrective action.

Get started with Tech Docs today

Current customers can see the benefits of Tech Docs right away, with zero additional configuration required! OpsLevel is already a central place developers visit to find answers to questions about services in their architecture. Developers will now find answers to even more questions.

If you're not yet an OpsLevel customer, what are you waiting for? Get in touch and request your custom demo today!

More resources

March Product Updates
Blog
March Product Updates

Some of the big releases from the month of March.

Read more
How Generative AI Is Changing Software Development: Key Insights from the DORA Report
Blog
How Generative AI Is Changing Software Development: Key Insights from the DORA Report

Discover the key findings from the 2024 DORA Report on Generative AI in Software Development. Learn how OpsLevel’s AI-powered tools enhance productivity, improve code quality, and simplify documentation, while helping developers avoid common pitfalls of AI adoption.

Read more
Introducing OpsLevel AI: Finding Your Lost Engineering Knowledge
Blog
Introducing OpsLevel AI: Finding Your Lost Engineering Knowledge

Read more
Product
Software catalogMaturityIntegrationsSelf-serviceKnowledge CenterBook a meeting
Company
About usCareersContact usCustomersPartnersSecurity
Resources
DocsEventsBlogPricingDemoGuide to Internal Developer PortalsGuide to Production Readiness
Comparisons
OpsLevel vs BackstageOpsLevel vs CortexOpsLevel vs Atlassian CompassOpsLevel vs Port
Subscribe
Join our newsletter to stay up to date on features and releases.
By subscribing you agree to with our Privacy Policy and provide consent to receive updates from our company.
SOC 2AICPA SOC
© 2024 J/K Labs Inc. All rights reserved.
Terms of Use
Privacy Policy
Responsible Disclosure
By using this website, you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts. View our Data Processing Agreement for more information.
Okay!