By Kate Mueller on Writing docs from November 8, 2023
I have a brief confession to make: I hate SEO (Search Engine Optimization). I don't like fielding questions about it and it's usually the last thing I'm thinking about when I'm working on content.
But our Support Knowledge Base is a publicly-available knowledge base, which means that it's kind of a marketing tool by default: if people search for a question related to KnowledgeOwl, ideally they'd actually get results returned from our Support KB rather than from some other source.
So if, like me, you prefer to think about your content first and your SEO—well...never, unless forced—the tips below should give you some straightforward ways to incorporate some SEO-positive trends into your knowledge base without feeling like you've suddenly turned into a marketer.
One of the most powerful tools at your disposal is also one of the simplest: making the best use of your article and category title tags.
A title tag is an HTML element that specifies the title of a webpage. It's not actually displayed while you view the page—instead, this HTML element is tucked into the "head" of the page, like this:
It's meant to be an accurate and concise description of a page's content, but it gets used in a few additional ways:
All of which is to say: this is a very small field that has a LOT of reach.
I tend to forget about it in KnowledgeOwl for two reasons:
The good news is that I've been using this field without even realizing it. The less good news is that I haven't been optimizing for it.
If you're like me, here are a few tips to get that title tag to actually carry its weight:
I've found two resources especially helpful in thinking about title tags:
My second quick and dirty recommendation is also tucked at the very bottom of the KnowledgeOwl editor: the Meta Description.
A meta description is an HTML element that briefly summarizes the content of a web page. Like the title tag, it's not actually displayed while you view the page—instead, this HTML element is tucked into the "head" of the page, like this:
Social media platforms will use the meta description as the text preview for your article or category, so like the title tag, it's a field that has a lot of reach. If you don't have a meta description, social media platforms generally just grab the first 150-ish characters they find.
Search engines will often use the meta description, but not always—sometimes they'll display a relevant fragment from the page based on the end-user's search query, instead.
Either way, there's a lot of reach and visibility with these descriptions, so it's worth scrolling down to the bottom of the KnowledgeOwl editor to add one!
Unlike the title tag, there are some places where the meta description may be displayed in your knowledge base, so it's worth knowing that's happening before you start editing them:
The good news is that both of these use cases will benefit from you writing intentional, well-crafted meta descriptions. Following SEO best practices can also improve your readers' experience of your knowledge base in general!
But unlike the title tag, KnowledgeOwl doesn't do anything to auto-populate the meta description field, so unless you've been aware of it and using it, you're missing a key SEO/social sharing opportunity. Here are some general tips on getting the most out of this field:
I've found two resources especially helpful in thinking about meta descriptions:
Search engines like to follow links—whether those are links within your knowledge base, external links directing people into your knowledge base, or links from your knowledge base to external resources.
So having broken links doesn't exactly make them happy.
Here are a few tips on how to clean up broken links.
When you delete or archive an article or category—or when you edit the permalink for a given article or category—you can create bad links. Search engines can hold onto these, especially if your company's website, blog, or some other external resource is still using the dead hyperlink.
The easiest way to figure out if you have any of these is to use a third-party tool to evaluate SEO or search behavior. Most of these tools provide a web crawling service that will identify dead links in your knowledge base.
Once you get a list of the URLs in your knowledge base that are throwing errors, figure out the best way to remedy them:
Once you've made these changes, you'll likely need to request a reindex or recrawl of the URL from your third-party tool to get the errors to disappear.
If you're looking for an SEO tool, you could consider:
If you found a lot of errors in the previous step, it's worth it to avoid creating more of them.
Be sure your knowledge base has the Editor Setting turned on to Automatically prompt to create a redirect link when changing the content's current permalink. In KnowledgeOwl, this option is in the bottom of Settings > Basic and will help you handle the old links process as you update permalinks moving forward—it saves a ton of time!
Once you have finished fixing bad links for your articles or categories, go one step further and figure out where you have bad outgoing links.
Our Broken Link Checker can help you identify bad links.
If you have a public knowledge base, generating a sitemap for that knowledge base is one of the easiest ways to encourage search engines to index and return your content.
In KnowledgeOwl, head to Settings > Basic to the Domain Settings section and check the box next to Generate a publicly available sitemap. This will ensure that a sitemap exists for your knowledge base, and we'll update that sitemap as you add, remove, and update content in your knowledge base.
This is my favorite SEO tip, and hopefully it's something you're already doing.
Write relevant, amazing content that answers the questions people might search for. Break up walls of text into numbered or bulleted lists. Add images, videos, and other media—this can help boost your rankings. (Alt text for images can be a great way to get some more keywords worked in, while also improving accessibility!)
At the end of the day, the content itself is really what's going to drive people to your knowledge base and keep them there.
General posts useful to all documentarians about writing documentation, editing and publishing workflows, and more.
Your flight plan for how to get the most out of KnowledgeOwl features and integrate them into your workflows.
Major KnowledgeOwl company announcements.
Learn how others are using KnowledgeOwl & get pro tips on how to make the most of KO!
Find out more about who we are and what we value.
We believe good support is the foundation of good business. Learn about support tools and methodology.
Learn more about tools to solve various documentarian issues, within and beyond KnowledgeOwl.
Not sure what category you need? Browse all the posts on our blog.
Watch a 5-minute video and schedule time to speak with one of our owls.