assess-readability

To calculate readability scores for documentation, this tool measures Flesch Reading Ease, Flesch-Kincaid Grade, Gunning Fog Index, and LIX. It automatically excludes auto-generated content like changelogs and CRDs to focus on actual documentation pages.

Yes, you can scan entire directories or single files to evaluate content accessibility. The tool allows flexible scanning with options to include index pages and exclude specific paths, flagging pages that exceed a certain difficulty threshold for review.

Yes, the readability assessment automatically excludes auto-generated sections such as changelogs and CRDs. This ensures that only manually written documentation pages are evaluated for content accessibility and simplification needs.

The evaluation uses four readability metrics: Flesch Reading Ease, Flesch-Kincaid Grade, Gunning Fog Index, and LIX. These metrics measure English readability to help identify documentation content that may need simplification for better accessibility.

No external dependencies are required. The documentation readability scanner requires only the Python standard library to calculate readability metrics and assess English content accessibility across your files and directories.