Add documentation for Free, Premium, and other add-on assessments to developer.yoast.com
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 30/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- javascript
调研方向
首先检查 docs/features/analysis 下的现有结构以及 Docusaurus 的文档约定。使用链接的 SCORING SEO.md、SCORING READABILITY.md 和 SCORING INCLUSIVE LANGUAGE.md 文件作为源材料；添加 assessments/overview.md 以及所请求的、针对各项评估的文件夹和页面，且不删除或移动 yoastseo 文档，即视为完成。
由索引模型根据 Issue 内容生成。
描述
Please give us a description of the issue
- I've read and understood the contribution guidelines.
- I've searched for any related issues and avoided creating a duplicate 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:
---
id: overview
title: "Assessments: Overview"
sidebar_label: Overview
description: 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:
- Add documentation for e-commerce specific assessments and scoring criteria to developer.yoast.com
- Add documentation for add-on specific assessments to developer.yoast.com
Example of how this will look:
SEO
Readability
Inclusive Language
- Age
- Appearance
- Culture
- ...
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 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: KeyphraseLengthAssessment
title: "Assessments: KeyphraseLengthAssessment"
sidebar_label: Keyphrase Length
description: This documentation provides an overview of the Keyphrase Length Assessment.
---
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:
| Keyphrase length | |
|---|---|
| Name In Code | KeyphraseLengthAssessment |
| Title URL: | https://yoa.st/33i (link placement is in bold in the feedback strings) |
| Call to action URL | https://yoa.st/33j (link placement is in bold in the feedback strings) |
| What it does | 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. |
| Uses synonyms | ❌ |
| When it applies | Always. |
| Addon/Premium | ❌ <whether it is part of an addon or premium> |
| Languages | Agnostic |
| Cornerstone | ❌ <whether it is changed by cornerstone toggle> |
| Uses highlighting | ❌ |
| Uses morphology in premium | ❌ |
| Other | <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
| Bullet | Score | Criterion | Feedback |
|---|---|---|---|
| Red | -999 | No focus keyword set | 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
- 主要语言
- JavaScript
- 星标
- 15
- 派生
- 23
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
Yoast/developer 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 78/100
-
难度 5/5 一周以上 新手友好度 25/100
-
Typos未关闭
难度 2/5 1-3 小时 新手友好度 48/100
-
bug
难度 3/5 1-2 天 新手友好度 55/100
-
难度 4/5 3-5 天 新手友好度 35/100
相似的 Issue
-
bug good first issue
难度 2/5 1-3 小时 新手友好度 86/100
amponce/archive-movie-browser#354 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 74/100
saayam-for-all/webapp#1870 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
Imageomics/OpenCite#66 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 64/100
chr15m/twiiit.com#20 ·
-
documentation
难度 2/5 1-3 小时 新手友好度 88/100
antropos17/Aegis#629 ·
维护者通常 4 天内回复