skills.rest
joesys
joesysCOMMUNITY
Explore all skills by this author →
GitHub

readability-review

Grades code readability across eight dimensions with numeric scores and refactoring suggestions.

1|Updated Mar 24, 2026
Search Tags:#narrative#refactoring#readability#metrics#governance#code-review#dimensions
One-click install
npx skills add https://github.com/joesys/joesys-skills --skill readability-review-joesys
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readability-review
Source: https://github.com/joesys/joesys-skills/tree/main/skills/readability-review
Command: npx skills add https://github.com/joesys/joesys-skills --skill readability-review-joesys

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Grade code readability across eight dimensions to produce numeric scores and actionable refactoring suggestions.

Core Features & Use Cases

  • Scoring across 8 fixed dimensions per file or per project
  • Generates a weighted overall score and a per-dimension breakdown
  • Provides before/after refactoring suggestions for low-scoring areas with clear rationale

Quick Start

Run the readability-review command against your codebase to obtain an intelligible, action-oriented readability report.

Frequently Asked Questions about readability-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I score code readability across multiple dimensions for a refactoring review?▼

Code readability is graded across eight fixed dimensions, generating a weighted total from 0–100 alongside actionable refactoring suggestions. This file-by-file analysis provides a per-dimension breakdown to guide your review.

Can I get readability metrics and before/after examples for a PR diff context?▼

Yes, readability metrics can be generated including diff context specifically for PR reviews. The analysis requires before/after refactoring examples for any findings, ensuring clear, actionable rationale for low-scoring areas within your pull requests.

What is the best way to enforce code readability governance in various programming languages?▼

Enforcing code readability governance involves applying per-dimension scoring across various languages to produce a standardized 0–100 weighted total. This methodical file-by-file analysis identifies specific structural weaknesses to improve overall codebase quality.

Does the readability review process provide actionable refactoring suggestions for low-scoring code?▼

Yes, the readability review provides actionable refactoring suggestions specifically for low-scoring areas. It enforces the inclusion of before/after examples with clear rationale for any findings, ensuring you know exactly how to improve the targeted dimensions.

How do I generate an action-oriented readability report for my codebase?▼

You generate an action-oriented readability report by running a readability review command against your codebase. This produces an intelligible breakdown of eight dimensions, yielding numeric scores and actionable refactoring suggestions for file-by-file improvements.

Related Skills

Explore More Software Engineering Skills→
nthpaulnthpaul

bugbot-review

Generates deduplicated code review findings from BUGBOT.md and whole-diff analysis.

Community
Advanced
atholaathola
326

evaluation-framework

Evaluate artifacts using weighted criteria and threshold-based decision rules.

Community
Basic
jiroamatojiroamato

pr

Create pull requests from current branches using GitHub templates and validation checks.

Community
Intermediate
webdriveriowebdriverio
11

Global Coding Style

Enforce global coding style conventions across codebases during file creation or modification.

Official
Basic