SEO Management
In the digital age, visibility on search engines is critical for any product, and your technical documentation is no exception. Theneo's SEO Management tools provide you with all the options you need to optimize your documentation for search engines, enhancing visibility, and making it easier for your users to find the information they need.
Navigating to the SEO Management section in your project settings will reveal an array of options to customize your project's SEO. Here's what you can do:
Title, Meta Description, and Keywords
Your project's SEO title and meta description are what users see in search engine results. The SEO title is the main title that appears in search engine results, and the meta description is the brief summary underneath. In Theneo, you can customize these for every section of your project, ensuring that each part of your documentation is accurately represented in search engine results.
Adding relevant keywords is another crucial aspect of SEO. Theneo's SEO Management allows you to input keywords related to each section of your project, helping search engines understand the content and context of your documentation better.
Open Graph Management
Open Graph protocol enhances the richness of your project when shared on social media platforms like Facebook and LinkedIn. With Theneo, you can manage Open Graph settings, such as the title, description, and image, to control how your project appears when shared on social platforms. This not only enhances the look of your shared links but can also improve engagement and click-through rates.
No-Index Option
There may be instances where you want your project to be public but not indexed by search engines. For example, if the project is still in the early stages or contains sensitive information. In these cases, Theneo allows you to enable the 'no-index' option. This instructs search engines not to index your project, ensuring it won't appear in search results even while being publicly accessible.
SEO management in Theneo provides a blend of accessibility and control. It ensures that your technical documentation can reach your intended audience effectively, be it through search engines or social media platforms, while giving you the control to guide that visibility as per your project's requirements.
Sitemap generator
The Sitemap Generator helps you export an up-to-date XML sitemap for your project’s public documentation - so search engines can discover and index your docs more effectively. Sitemaps are generated on demand from the SEO Management tab and can be downloaded instantly.
Importantly, any documentation sections marked Private through Advanced Access Management are automatically excluded, ensuring sensitive content is never exposed.
What you can do
With Sitemap Generator, project Editors and Admins can:
- Generate a sitemap XML for the Project
- Download the sitemap file immediately
Where to find it
- Open your Project
- Navigate to SEO Management
- Find the Generate Sitemap button
The sitemap contains only publicly visible documentation URLs for your Project Portal.
Privacy and access rules
Private content is never included
Pages and sections marked Private in Advanced Access Management are excluded automatically. This prevents restricted documentation from appearing in:
- Sitemaps
- Search engine discovery workflows.
When to regenerate your sitemap
Since generation is manual, regenerate whenever you make meaningful changes to public docs, such as:
- Publishing new pages
- Changing slugs or URLs
- Reorganizing navigation
- Making previously-private content public (or vice versa)
FAQ
What made this section unhelpful for you?
On this page
- SEO Management