Health check metrics
  • 10 Nov 2022
  • 5 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Health check metrics

  • Dark
    Light
  • PDF

Health check metrics help you optimize the article's SEO and readability. It gives you valuable insights into the current problems, suggestions, and good work in the content. This feature is available only for articles and category pages of the English language.


Accessing Health check metrics

2_Screenshot-Health_check_metrics_UI

  1. Go to the desired article in the Documentation editor
  2. Click Health check metrics on the right menu bar
  3. Insights of your article's health check metrics appear. It has two major sections:

If you update any parameter with the 'Health check metrics blade' open, click Check now to view the insights of the latest changes.

Metrics classification

The metrics are classified into three sections,

  • Problems - Parameters that need immediate actions
  • Suggestions - Parameters that need improvement
  • Good work - Parameters that are currently optimal

SEO metrics

You can find the SEO metrics of your article in this section. It shows the insights of the below parameters:

  1. Meta title length
  2. Meta description length
  3. External links
  4. Internal links
  5. Featured image

1_Screenshot-SEO_metrics_UI

1. Meta title length

This parameter shows the length of your article meta title. If an improvement is required, the recommended length appears, and an option to update it instantly. The recommended meta title length of an article is 50-70 characters (including spaces).

  • If the character length (including spaces) of the meta title is less than 30 or more than 90, it appears under Problems with a link to update it. You can click on the Update now link to navigate to the respective section
  • If the character length (including spaces) of the meta title is between 30-49 or 71-90, it appears under Suggestions with a link to update it. You can click on the Update now link to navigate to the respective section
  • If the character length (including spaces) of the meta title is between 50-70, it appears under Good work

Meta title is the article title text appearing in the search engine results and the browser tabs.


2. Meta description length

This parameter shows the length of your article meta description. If an improvement is required, the recommended length appears, and an option to update it instantly. The recommended meta description length of an article is 120-160 characters (including spaces).

  • If the character length (including spaces) of the meta description is less than 80 or more than 160, it appears under Problems with a link to update it. You can click on the Update now link to navigate to the respective section
  • If the character length (including spaces) of the meta description is between 80-119, it appears under Suggestions with a link to update it. You can click on the Update now link to navigate to the respective section
  • If the character length (including spaces) of the meta description is between 120-160, it appears under Good work

Meta description is the summary of an article. It appears in the search engine results as a short description of the article.


3. External links

This parameter shows the availability of the external links in the article. If no external links are available, it suggests you add one.

  • If no external link is added or more than three external links are added, it appears under Suggestions
  • If there are one to three external links, it appears under Good work

External links are the links used that point to a web location outside your Document360 project.


4. Internal links

This parameter shows the availability of the internal links in the article. If no internal links are available, it suggests you add one.

  • If no internal link is added or more than three internal links are added, it appears under Suggestions
  • If there are one to three internal links, it appears under Good work

Internal links are the article links, category index links, category page links, anchor links, tag links, and contributor links within your Document360 project. Media file links are not considered as internal links.


5. Featured image

This parameter shows the availability of the featured image in the article. If no featured image is available, it suggests you add one.

  • If no featured image is added, it appears under Suggestions
  • If a featured image is added, it appears under Good work

Featured image will appear with an SEO title and description when the article link is shared on social media or other websites.


Readability metrics

You can find the readability metrics of your article in this section. It shows the insights of the below parameters:

  1. Readability score
  2. Paragraph length
  3. Sentence length
  4. Sub-heading distribution
    2_Screenshot-Readability_metrics_UI

1. Readability score

The readability score shows how readable your article is out of 100. The higher score indicates that the article content is more readable.
For more information, visit the Readability score article.

  • If the readability score is below 30, it appears under Problems
  • If the readability score is between 30-59, it appears under Suggestions
  • If the readability score is more than 59, it appears under Good work

2. Paragraph length

This parameter shows insights into the paragraph's length in your article. Long paragraphs would be difficult to read, and readers would find it hard to keep track of the content.

It is recommended to use shorter paragraphs for better readability. The optimal paragraph word count is 150 words or less.

  • If any paragraph has more than 150 words, it appears under Suggestions
  • If all paragraphs have less than 150 words, it appears under Good work

What is considered a paragraph?

  • Two or more sentences without a break

3. Sentence length

This parameter shows insights into the sentence length in your article. Long sentences would be difficult to read, and readers would find it hard to keep track of the content.

It is recommended to use shorter sentences for better readability. The optimal sentence length is 20 words or less.

  • If any sentence has more than 20 words, it appears under Suggestions
  • If all sentences have less than 20 words, it appears under Good work

What is considered a sentence?

  • A group of words with a full stop at the end
  • If the ordered and unordered list contains no full stop at the end, it will be considered as a single sentence

4. Sub-heading distribution

This parameter shows the availability of the sub-headings in the article. It is recommended to use sub-headings for better readability, and it assists the readers in identifying the multiple sections in the article. If no sub-heading is available, it suggests you add one.

  • If no sub-heading is added, it appears under Suggestions
  • If a sub-heading is added, it appears under Good work

In Document360, you can use the Heading (H2/H3/H4) tags to add subheadings. Heading tags are available at the foremost of the toolbar. Subheadings grab the attention of the readers. It helps them to easily navigate to their desired topics. If the table of contents is enabled, the subheadings appear under it.

Limitation

Readability metrics will not consider LaTeX expressions and code blocks.


Was this article helpful?