This module provides guidelines on writing and optimizing knowledge base articles for search engines. Following these best practices ensures your articles are discoverable, improve click-through rates, and deliver a better user experience through high-quality, search-friendly content.
Search Engine Optimization (SEO) helps increase the visibility of your articles in search results, driving organic traffic to your knowledge base. Well-optimized articles improve both user engagement and findability by aligning with SEO best practices.
SEO best practices
Meta title guidelines
Keep titles between 50–60 characters to avoid truncation.
Include primary keywords at the beginning of the title.
Ensure titles accurately reflect the content.
Avoid redundancy and keyword stuffing.
Optionally add your brand name at the end (if space allows).
Example:
Configure SSO using Okta in Document360
SEO description guidelines
Write descriptions between 155–160 characters.
Make them concise and informative.
Use primary and secondary keywords naturally.
Align with user intent—answer what the reader is searching for.
Add calls to action like Learn more, Discover, or Get started.
Ensure each article has a unique SEO description.
Avoid keyword stuffing.
Example:
Learn how to configure SSO using Okta in Document360 for secure, seamless access with organizational credentials.
Optimizing article structure for SEO
Use clear, descriptive headings (H2, H3, H4) with keywords.
Add 1–3 internal links to related knowledge base articles.
Include 1–3 external links to authoritative sources where relevant.
Ensure the slug (URL) is concise, lowercase, and keyword-friendly.
Avoid stop words in slugs (like and, the, of).
Example slug:
/configuring-sso-okta-saml
Using the AI SEO description generator (Exclusive to Document360 users)
The AI-powered SEO description generator in Document360 allows you to quickly create optimized meta descriptions for your knowledge base articles. This feature is designed to save you time while ensuring your content is SEO-friendly.
Prerequisites
Document360 account required: Eddy AI is only accessible through the Document360 platform.
The article must have over 200 preprocessed words (excluding HTML tags, images, and code blocks).
Sufficient Eddy AI credits must be available.
Only English-language articles are supported for AI generation.
How to generate:
Open the article and select More (•••) > SEO.
In the SEO tab, click Ask Eddy AI.
Review the generated description and save if satisfactory.
PRO TIP
Always review AI-generated descriptions for accuracy and intent before publishing.
Readability for SEO (Exclusive to Document360 users)
Search engines favor content that is easy to read. Use the Readability metrics in Document360’s Health check metrics to assess your article.
Key readability guidelines:
Readability score: Aim for a score above 60.
Sentence length: Keep sentences under 20 words.
Paragraph length: Limit paragraphs to 150 words.
Sub-headings: Break content into sections with clear headings.
Avoid long, complex sentences or dense blocks of text.
Score reference:
90–100: Very easy to read
80–89: Easy to read
70–79: Fairly easy to read
60–69: Easily understood
30–59: Fairly difficult to read
0–29: Hard to read
Health check metrics (Exclusive to Document360 users)
The Health check metrics panel in Document360 provides real-time insights to improve SEO and readability.
Monitored SEO metrics:
SEO title length
SEO description length
Internal and external link count
Featured image presence
Metrics are classified as:
Problems (needs immediate action)
Suggestions (requires improvement)
Good Work (optimal)
Review these metrics regularly to maintain article quality and discoverability.
Managing SEO for multiple articles (Exclusive to Document360 users)
You can bulk-manage SEO descriptions using:
Content tools → Documentation → SEO description.
From here, you can:
Filter articles based on SEO status.
Generate descriptions in bulk with Eddy AI.
Save or discard individual descriptions after review.
NOTE
Knowledge base–level SEO settings like sitemaps and robots.txt are managed by administrators. Writers do not need to configure these but should be aware they control how search engines index the knowledge base as a whole.
Common SEO mistakes to avoid
Missing SEO titles or descriptions.
Using duplicate meta descriptions across articles.
Keyword stuffing in titles or descriptions.
Long, complex sentences reducing readability.
Forgetting to add internal links.
Ignoring Health check metrics feedback.
By following these guidelines, you can ensure your articles are optimized for search engines and provide a seamless reading experience. Proper SEO not only increases article visibility but also drives more organic traffic and improves user engagement.