You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Within this folder create one overview.md with some general information and links to all assessment specific docs. Could also contain a legend/explanation of the card system (see below).
This should have a docusaurus header like so:
---id: overviewtitle: "Assessments: Overview"sidebar_label: Overviewdescription: This documentation provides a list of all our assessments.---
This overview should contain a list of all (Free and Premium) SEO, Readability and Inclusive Language assessments by their type/source. And all assessments should link to the assessment specific page (see below). Note: there are separate tasks to add documentation related to add-ons and Shopify:
Within the assessments folder, create a folder for each assessment type/source. NOTE: use snake casing as this appears to be the convention withing developer.yoast.com. For example inclusive-language.
In each respective folder, create an .md file for each assessment. (Again, use snake casing: keyphrase-in-introduction.md)
Each file should have a Docusaurus header at the top. For example:
---id: KeyphraseLengthAssessmenttitle: "Assessments: KeyphraseLengthAssessment"sidebar_label: Keyphrase Lengthdescription: This documentation provides an overview of the Keyphrase Length Assessment.---
Checks whether the number of ( content ) words in the keyphrase is within the recommended limit. For languages with function word support only content words are considered. For languages without function word support all words are considered.
Keyphrase length: No focus keyphrase was set for this page. Set a focus keyphrase in order to calculate your SEO score.
Red
3
Keyphrase length > 8 words (> 9 for languages without function words support)
Keyphrase length: The keyphrase contains x (content) words. That's way more than the recommended maximum of 4 (content) words. Make it shorter!
Orange
6
Keyphrase length between 5-8 words (7-9 for languages without function words support)
Keyphrase length: The keyphrase contains x (content) words. That's more than the recommended maximum of 4 (content) words. Make it shorter!
Green
9
Keyphrase length between 1-4 words (1-6 or languages without function words support)
Keyphrase length: Good job!
Below this card there is space for free text/context/screenshots/desired behaviour.
Do not remove these cards from the yoastseo package. Also do not move any other documentation from the yoastseo package. There is a separate task to deal with that: https://github.com/Yoast/lingo-other-tasks/issues/211
The text was updated successfully, but these errors were encountered:
agnieszkaszuba
changed the title
Add documentation for assessments to developer.yoast.com
Add documentation for Free and Premium assessments to developer.yoast.com
Jul 20, 2023
Please give us a description of the issue
This task was created as part of this task: https://github.com/Yoast/non-dev-tasks/issues/39
See report in first comment to this task for context.
All assessments:
In developer/docs/features/analysis create a folder called
assessments
.overview.md
Within this folder create one
overview.md
with some general information and links to all assessment specific docs. Could also contain a legend/explanation of the card system (see below).This should have a docusaurus header like so:
This overview should contain a list of all (Free and Premium) SEO, Readability and Inclusive Language assessments by their type/source. And all assessments should link to the assessment specific page (see below). Note: there are separate tasks to add documentation related to add-ons and Shopify:
Example of how this will look:
SEO
Readability
Inclusive Language
Assessment specific pages
Within the
assessments
folder, create a folder for each assessment type/source. NOTE: use snake casing as this appears to be the convention withing developer.yoast.com. For exampleinclusive-language
.In each respective folder, create an .md file for each assessment. (Again, use snake casing:
keyphrase-in-introduction.md
)Each file should have a Docusaurus header at the top. For example:
Docusaurus will interpret this header.
Each file could contain a card with some essential information in a structural format. This could also house some information from SCORING SEO.md, SCORING READABILITY.md and SCORING INCLUSIVE LANGUAGE.md that is not in the second card below. For example:
<whether it is part of an addon or premium>
<whether it is changed by cornerstone toggle>
<Any additional info that might be relevant.>
Below this card, create a card for scoring. This can be copied from SCORING SEO.md, SCORING READABILITY.md and SCORING INCLUSIVE LANGUAGE.md. For example
Below this card there is space for free text/context/screenshots/desired behaviour.
Do not remove these cards from the
yoastseo
package. Also do not move any other documentation from theyoastseo
package. There is a separate task to deal with that: https://github.com/Yoast/lingo-other-tasks/issues/211The text was updated successfully, but these errors were encountered: