docs(platform:actors): Actor quality score #2005
Conversation
VojtaKai
changed the title
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Just one comment, otherwise it looks good. Thanks! Good job. |
|
Preview for this PR was built for commit |
|
From what it needs to communicate, I think it works well. One nitpick from me would be regarding the formatting. It's a lot of text, and I wonder if we could break it into bullet points and some bold sentences, etc., to make it visually clearer. It's not something that should block it. We can always improve it later, so it's an approve from me. |
|
I'll agree it kind of wall-of-text, I will be taking proper look at it today I'll try to break it up into smaller chunks Just FYI, per our style guide, bold is reserved for UI elements. At the same time bullet lists, bolded sentences, emojis are dead giveaway of AI/LLM generated content, we do not want our docs to look AI/LLM generated. We want to make our content easily digestable by AI/LLMs, which we can accomplish by making it concise, and adhere with technical writing principles |
|
|
There was a problem hiding this comment.
Some changes requested as well as few further questions:
- Do we want to provide some scale from which user can infer what score is considered good? As in, something like:
## Understanding your score
| Score | Rating | Description |
|-------|--------|-------------|
| 90-100 | Excellent | Top visibility in Store |
| 75-89 | Good | Strong Store presence |
| 60-74 | Fair | Room for improvement |
| Below 60 | Needs work | Limited visibility |
- Do we want to share what is the update frequency? Is it real-time or once a day or something?
|
|
||
| ## How to view your score | ||
|
|
||
| Navigate to Console → Insights → Actor Quality Tab → Select Actor |
There was a problem hiding this comment.
| Navigate to Console → Insights → Actor Quality Tab → Select Actor | |
| Navigate to **Console >Insights > Actor Quality**, and then select your Actor. |
| sidebar_position: 5 | ||
| --- | ||
|
|
||
| The Actor quality score is a metric that evaluates your Actor's overall performance across multiple dimensions, including reliability, ease of use, popularity, and other quality indicators. Scores range from 0 to 100 and directly influence your Actor's visibility and placement in the Apify Store. |
There was a problem hiding this comment.
| The Actor quality score is a metric that evaluates your Actor's overall performance across multiple dimensions, including reliability, ease of use, popularity, and other quality indicators. Scores range from 0 to 100 and directly influence your Actor's visibility and placement in the Apify Store. | |
| The Actor quality score is a metric that evaluates your Actor's performance across multiple dimensions, including reliability, ease of use, popularity, and other quality indicators. Scores range from 0 to 100 and influence your Actor's visibility and placement in the Apify Store. |
|
|
||
| Actors with limited permissions build user confidence and trust, making users more likely to adopt them. Conversely, the absence of limited permissions will negatively impact your quality score. | ||
|
|
||
| Limited permissions are designed to support the vast majority of Actor use cases without restricting functionality. If your Actor requires access to resources beyond what limited permissions provide, contact the Apify support team to discuss your specific requirements. |
There was a problem hiding this comment.
| Limited permissions are designed to support the vast majority of Actor use cases without restricting functionality. If your Actor requires access to resources beyond what limited permissions provide, contact the Apify support team to discuss your specific requirements. | |
| Limited permissions support the vast majority of Actor use cases without restricting functionality. If your Actor requires access to resources beyond what limited permissions provide, contact the Apify support team to discuss your specific requirements. |
|
|
||
| ## Overview | ||
|
|
||
| The Actor quality score aggregates multiple performance and quality metrics into a single numerical rating. This score serves as a key indicator of your Actor's health and user satisfaction, affecting its discoverability in the Store. |
There was a problem hiding this comment.
| The Actor quality score aggregates multiple performance and quality metrics into a single numerical rating. This score serves as a key indicator of your Actor's health and user satisfaction, affecting its discoverability in the Store. | |
| The Actor quality score aggregates multiple performance and quality metrics into a single numerical rating. This score indicates your Actor's health and user satisfaction. A higher score improved your Actor's discoverability in Apify Store. |
There was a problem hiding this comment.
A higher score improves* your Actor's discoverability in Apify Store.
| - reliability | ||
| - popularity | ||
| - feedback and community | ||
| - ease of use | ||
| - pricing transparency | ||
| - trustworthiness | ||
| - history of success | ||
| - congruency of texts |
There was a problem hiding this comment.
| - reliability | |
| - popularity | |
| - feedback and community | |
| - ease of use | |
| - pricing transparency | |
| - trustworthiness | |
| - history of success | |
| - congruency of texts | |
| - Reliability | |
| - Popularity | |
| - Feedback and community | |
| - Ease of use | |
| - Pricing transparency | |
| - Trustworthiness | |
| - History of success | |
| - Congruency of texts |
|
Q: Do we want to provide some scale from which user can infer what score is considered good? Q: Do we want to share what is the update frequency? Is it real-time or once a day or something? |
|
Preview for this PR was built for commit |
There was a problem hiding this comment.
Some final things I noticed, and 2 more follow-up questions regarding the score itself
- We say that based on the score your Actor is better than X% of Actors on the platform.
Q: If others are improving their Actors does that affect this number?
2. Should we really be saying that something is better than 100% of Actors on the platform? Is that even a possibility?
Disregard Q2, I see it is fixed :D
| - History of success | ||
| - Congruency of texts | ||
|
|
||
| The following section provides detailed guidance on each quality category. |
There was a problem hiding this comment.
I think we can remove that sentence completely, the goal of next section is obvious so I don't think we need to be this explicit.
|
|
||
| ### Pricing transparency | ||
|
|
||
| Pricing transparency evaluates how clearly users can understand and predict the costs of running your Actor. Transparent pricing models help users make informed decisions and budget accordingly. The [Pay Per Event (PPE)](https://docs.apify.com/platform/actors/publishing/monetize/pay-per-event) monetization model provides predictable, event-based pricing that makes costs explicit and easier to estimate. |
There was a problem hiding this comment.
| Pricing transparency evaluates how clearly users can understand and predict the costs of running your Actor. Transparent pricing models help users make informed decisions and budget accordingly. The [Pay Per Event (PPE)](https://docs.apify.com/platform/actors/publishing/monetize/pay-per-event) monetization model provides predictable, event-based pricing that makes costs explicit and easier to estimate. | |
| Pricing transparency evaluates how clearly users can understand and predict the costs of running your Actor. Transparent pricing models help users make informed decisions and budget accordingly. The [Pay per event (PPE)](https://docs.apify.com/platform/actors/publishing/monetize/pay-per-event) monetization model provides predictable, event-based pricing that makes costs explicit and easier to estimate. |
|
|
||
| Pricing transparency evaluates how clearly users can understand and predict the costs of running your Actor. Transparent pricing models help users make informed decisions and budget accordingly. The [Pay Per Event (PPE)](https://docs.apify.com/platform/actors/publishing/monetize/pay-per-event) monetization model provides predictable, event-based pricing that makes costs explicit and easier to estimate. | ||
|
|
||
| Consider offering Store Discounts for Bronze, Silver, and Gold subscription tiers. These incentives reward committed platform users and can increase your Actor's adoption among engaged customers. |
There was a problem hiding this comment.
| Consider offering Store Discounts for Bronze, Silver, and Gold subscription tiers. These incentives reward committed platform users and can increase your Actor's adoption among engaged customers. | |
| Consider offering discounts for Bronze, Silver, and Gold subscription tiers. These incentives reward committed platform users and can increase your Actor's adoption among engaged customers. |
| ## Score update frequency | ||
|
|
||
| The Actor quality score recalculates several times per day. Changes you make to your Actor may not immediately reflect in your score or improvement recommendations. Improvement recommendations may continue to appear for a period of time after you have addressed the underlying issues. No newline at end of file |
There was a problem hiding this comment.
I think the admonition near the top is enough, this does not provide much more information than admonition itself. So no need to double the information
There was a problem hiding this comment.
It does. I want to implicitly let them know if they fix something, the improvement recommendations are still going to be visible.
There was a problem hiding this comment.
In that case I would remove the admonition and put whole ## Score update frequency section where admonition was. This way it makes more sense, it's at the top instead of being stuck at the end of doc
| :::note Score updates are not immediate | ||
| Changes to your Actor may take time to reflect in your score and improvement recommendations. For more information, see [Score update frequency](#score-update-frequency). | ||
| ::: |
There was a problem hiding this comment.
| :::note Score updates are not immediate | |
| Changes to your Actor may take time to reflect in your score and improvement recommendations. For more information, see [Score update frequency](#score-update-frequency). | |
| ::: | |
| :::note Score updates are not immediate | |
| Changes to your Actor may take time to reflect in your score and improvement recommendations. For more information, see [Score update frequency](#score-update-frequency). | |
| ::: |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Q: We say that based on the score your Actor is better than X% of Actors on the platform. If others are improving their Actors does that affect this number? A: Yes, it does! It basically returns in which percentile you score is compared to all other Actors on the platform. |
|
Preview for this PR was built for commit |
I don't think we mention it anywhere, and IMO it is pretty important info that score can change without any user action. |
Ohh, I think I misunderstood your question. The Actor quality score number does NOT change in response to changing Actor quality score numbers of other Actors. The number (X) inside the badge "Actor is better than X% of Actors on the platform" does change depending how well the actor does. |
The score may actually change because the equation is still being refined and new properties are added. |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
|
||
| _Score updates_: The Actor quality score recalculates several times per day. Changes you make to your Actor may take time to reflect in your score, and improvement recommendations may continue to appear in the Actor quality dashboard for a period after you have addressed the underlying issues. | ||
|
|
||
| _Score fluctuations_: Your quality score may change even without you modifying your Actor. This happens for two main reasons: First, your score is influenced by how well your Actor performs relative to other Actors on the platform. As other Actors improve or decline, your relative position may shift. Second, the quality score algorithm continues to evolve with new properties being added and adjustments to existing calculations. |
There was a problem hiding this comment.
| _Score fluctuations_: Your quality score may change even without you modifying your Actor. This happens for two main reasons: First, your score is influenced by how well your Actor performs relative to other Actors on the platform. As other Actors improve or decline, your relative position may shift. Second, the quality score algorithm continues to evolve with new properties being added and adjustments to existing calculations. | |
| _Score fluctuations_: Your quality score may change even without you modifying your Actor. This happens for two reasons: | |
| - Your score is influenced by how well your Actor performs relative to other Actors on the platform. As other Actors improve or decline, your relative position may shift. | |
| - The quality score algorithm continues to evolve with new properties being added and adjustments to existing calculations. |
|
|
||
| The platform provides in-app recommendations to help you identify improvement opportunities and optimize your Actor's quality score. | ||
|
|
||
| _Score updates_: The Actor quality score recalculates several times per day. Changes you make to your Actor may take time to reflect in your score, and improvement recommendations may continue to appear in the Actor quality dashboard for a period after you have addressed the underlying issues. |
There was a problem hiding this comment.
| _Score updates_: The Actor quality score recalculates several times per day. Changes you make to your Actor may take time to reflect in your score, and improvement recommendations may continue to appear in the Actor quality dashboard for a period after you have addressed the underlying issues. | |
| _Score updates_: The Actor quality score recalculates several times per day. Changes you make to your Actor may not immediately reflect in your score. Improvement recommendations may continue to appear in the Actor quality dashboard even after you have addressed the underlying issues. |
|
|
||
| _Score updates_: The Actor quality score recalculates several times per day. Changes you make to your Actor may take time to reflect in your score, and improvement recommendations may continue to appear in the Actor quality dashboard for a period after you have addressed the underlying issues. | ||
|
|
||
| _Score fluctuations_: Your quality score may change even without you modifying your Actor. This happens for two main reasons: First, your score is influenced by how well your Actor performs relative to other Actors on the platform. As other Actors improve or decline, your relative position may shift. Second, the quality score algorithm continues to evolve with new properties being added and adjustments to existing calculations. |
There was a problem hiding this comment.
Or
| _Score fluctuations_: Your quality score may change even without you modifying your Actor. This happens for two main reasons: First, your score is influenced by how well your Actor performs relative to other Actors on the platform. As other Actors improve or decline, your relative position may shift. Second, the quality score algorithm continues to evolve with new properties being added and adjustments to existing calculations. | |
| ### Score fluctuations | |
| Your quality score may change even without you modifying your Actor. This happens for two main reasons: First, your score is influenced by how well your Actor performs relative to other Actors on the platform. As other Actors improve or decline, your relative position may shift. Second, the quality score algorithm continues to evolve with new properties being added and adjustments to existing calculations. |
|
|
||
| The platform provides in-app recommendations to help you identify improvement opportunities and optimize your Actor's quality score. | ||
|
|
||
| _Score updates_: The Actor quality score recalculates several times per day. Changes you make to your Actor may take time to reflect in your score, and improvement recommendations may continue to appear in the Actor quality dashboard for a period after you have addressed the underlying issues. |
There was a problem hiding this comment.
| _Score updates_: The Actor quality score recalculates several times per day. Changes you make to your Actor may take time to reflect in your score, and improvement recommendations may continue to appear in the Actor quality dashboard for a period after you have addressed the underlying issues. | |
| ### Score updates | |
| The Actor quality score recalculates several times per day. Changes you make to your Actor may not immediately reflect in your score. Improvement recommendations may continue to appear in the Actor quality dashboard even after you have addressed the underlying issues. |
|
Preview for this PR was built for commit |
Article for Actor quality score. Each public Actor receives a score which tells the owner how well it is performing. There are seven main quality fields which are independently considered. The Actor quality score is the combined value of those.