Content Readability Score & Improvement Suggestions
This project helps content editors improve the readability of their Drupal content. It calculates a readability score for each piece of content and provides actionable suggestions to make it easier to understand, with a dashboard to track scores and identify content needing attention.
CRSIS (Content Readability Score & Improvement Suggestions) helps content editors and site administrators measure and improve the readability of their content using the Flesch-Kincaid Reading Ease formula. It provides a centralized dashboard with scores, grades, and actionable suggestions for every published node.
Features
- Readability Dashboard - A dedicated admin page (/admin/content/crsis-dashboard) that lists up to 50 published nodes with their readability scores, word counts, grade levels, and improvement suggestions.
- Flesch-Kincaid Scoring - Automatically calculates the Flesch-Kincaid Reading Ease score for each node's body field, providing a standardized measure of content complexity.
- 7-Level Grade System - Classifies content into grades: Very Easy, Easy, Fairly Easy, Standard, Fairly Difficult, Difficult, and Very Difficult.
- Actionable Suggestions - Flags content that falls below a configurable minimum score and offers specific tips such as shortening sentences or using simpler words.
- Color-Coded Score Badges - Visual indicators (green, amber, red) make it easy to spot content that needs attention at a glance.
- Summary Cards - The dashboard header shows total content analyzed, average readability score, count of good-readability nodes, and count of nodes needing improvement.
- Configurable Threshold - Administrators can set the minimum acceptable readability score through a settings form.
- Translatable - All user-facing strings are fully translatable for multilingual sites.
Post-Installation
- After enabling the module, navigate to Admin > Configuration > Content authoring > CRSIS Settings (/admin/config/content/crsis) to enable readability analysis and set your minimum acceptable score.
- Assign the "Access CRSIS dashboard" permission to roles that should view the dashboard, and "Administer CRSIS" to roles that should manage settings.
- Visit Admin > Content > CRSIS Dashboard (/admin/content/crsis-dashboard) to view readability scores for all published content.
- The module analyzes the body field of published nodes. Create or edit content and revisit the dashboard to see updated scores and suggestions.
Additional Requirements
- Drupal Core Node module (drupal:node) - Required dependency for accessing and analyzing node content.
- No additional contributed modules, external libraries, or third-party APIs are required. The Flesch-Kincaid calculation is handled entirely within PHP.
Supporting this Module
If you find this module helpful, consider:
- Reporting issues and feature requests in the issue queue (https://www.drupal.org/project/issues/crsis).
- Contributing patches or reviews.
- Sharing your experience with the module in the Drupal community.