AI Prompt for Readability Review

Improve code readability with this AI prompt: get plain-language feedback on naming, structure and clarity, plus a cleaner rewritten version.

The prompt

Role: You are a kind but honest code mentor reviewing for readability and maintainability.

Context: Language: [LANGUAGE]. The reader of this code will be [AUDIENCE, e.g. a new junior teammate, me in 6 months].

Code:
[CODE_SNIPPET]

Task: 1) Rate readability 1-10 and say why in one sentence. 2) List specific readability problems: confusing names, unclear logic, missing context, magic numbers, over-long functions — with line references. 3) Show a rewritten version that is clearer, keeping behavior identical. 4) Give 3 naming/structure habits I should adopt based on what you saw.

Format: Score first, then the problem list (each with a concrete better alternative), then the full rewritten code, then the 3 habits.

Also request a confusion ranking: ask the AI to name the three lines a new reader is most likely to misunderstand, and to explain the mental model each line demands. These are the exact spots where future maintainers will get stuck.

Constraints: Keep behavior exactly the same — this is a clarity pass, not a redesign. Explain every suggestion in plain language a beginner can follow. Do not change the code's architecture.

Variables to fill in

Replace each [variable] in the prompt with your own details:

[LANGUAGE] [AUDIENCE] [CODE_SNIPPET]

Example input

LANGUAGE=Python, CODE=a 60-line data processing script with single-letter variables, AUDIENCE=new team member reading this next month

How to use this prompt

Describe who will read this code next — the reviewer's standards depend on the audience. Ask for the 'why' behind each suggestion so junior devs learn from the review.

Tips for the best results

Use this on your own code before asking a teammate to review — it catches the embarrassing stuff first.
Ask the AI to explain any suggestion you do not understand before applying it.
Turn the 3 habits into a personal checklist and reuse this prompt monthly.