- 12 Jun 2023
- 2 Minutos para leer
- Colaboradores
- Impresión
- OscuroLigero
- PDF
Review reminder
- Actualizado en 12 Jun 2023
- 2 Minutos para leer
- Colaboradores
- Impresión
- OscuroLigero
- PDF
Review reminders help team accounts deliver the most accurate information to customers and internal teams by alerting project members when an article is ready for review. This helps to keep your article up to date.
Review reminder
Create and apply review reminders to flag an article for review immediately or set the review reminder to trigger on a specified date. You can also apply a review reminder individually or to a group of articles.
When an article needs review, a red dot (article status indicator) will show on the left of each article title in the documentation editor.
Creating a review reminder for an article from the documentation editor
- Go to an article, click on the article settings on the right
- Scroll down the list of menus, find the Review reminder section, and expand it
- Enter a reason for the review. Ensure it's descriptive enough to provide context for the team member tasked with reviewing the article. This field is optional
- Select a date for the reminder to trigger (Now, 30 days, 3 months, or Custom date)
- Click Save
A Needs review tag would appear next to the article slug in the Documentation editor. When team members hover over the 'Needs review' tag, they can view the reason for review (if given)
Clearing a review reminder
Once an article in need of review has been edited and updated
- Click the Needs review tag at the top of the article editor
- Click Mark as reviewed
The 'Needs review' tag is removed, and the article status indicator is reverted to the updated/draft/new status.
Managing review reminders in Bulk
Applying a reminder to multiple articles at a time
Instead of individually applying a review reminder to multiple articles, project admins can apply one reminder to a group of articles.
- Go to Content tools → Documentation → Article Review Reminders and click on the Add reminder
- Enter a name for the reminder
- Select how often the reminder will repeat (2 weeks, 30 days, 3 months, 6 months, 1 year)
Once a reminder time interval is set, all the articles selected in the reminder rule will trigger a 'Needs review' action irrespective of their publish date.
- In the Select Articles dropdown:
- Select the desired Project version
- Select the desiredlanguage
- Filter the desired articles with the below options in the Apply filters section:
- Author
- Category
- Date
- Tags
- In the Reminder recipients dropdown, select which Team member(s) will receive an email notification letting them know that the article needs review
Team members must be selected as a recipient of the email review reminder notification to receive this notification. However, the article(s) would be marked for review.
- Click Add.
You can also add review reminders to a group of articles with Bulk Operations
View all the 'Needs Review' articles
You can see every article with an active "Needs review" state within bulk operations.
- Go to Content tools → Bulk Operations
- Click on the Review required filter on the left
- The articles with the 'Needs review' is listed
Marking multiple articles as "Reviewed" or "Needs review"
You can mark multiple articles that need review as "reviewed" or vice versa using bulk operations.
- Go to Content tools → Bulk Operations
- In the filter option, select the Review reminder dropdown and select Stale
- Select the articles you want to mark as reviewed
- Click the Mark Reviewed option at the top
- Similarly, you can mark multiple articles as Needs review by selecting the articles and clicking on the Review reminder button at the top