reviewing-readability
Code readability review based on "The Art of Readable Code" and Miller's Law (7±2). Use when reviewing code clarity, improving naming, or when user mentions 可読性, 理解しやすい, わかりやすい, 明確, 命名, 変数名, 関数名, ネスト, 深いネスト, 関数設計, コメント, 複雑, 難しい, 難読, Miller's Law, ミラーの法則, 認知負荷, AI-generated, 過剰設計.
Installation
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
View source ↗GuidesSkill instructions
Readability Review
Detection
| ID | Pattern | Fix |
|---|---|---|
| RD1 | processData() (vague) |
validateUserEmail() |
| RD1 | Misleading identifiers | Names reveal intent |
| RD2 | Nesting > 3 levels | Guard clauses, extract functions |
| RD2 | Function > 30 lines | Decompose |
| RD3 | Comment: // increment i |
Delete (self-evident) |
| RD3 | Comment: // TODO: fix later |
Create issue or fix now |
| RD4 | Interface for single impl | Remove until 2nd impl |
| RD4 | Class for stateless logic | Pure function |
| RD5 | > 5 function parameters | Config object or decompose |
Thresholds
| Metric | Recommended | Maximum |
|---|---|---|
| Function lines | ≤30 | 50 |
| Nesting depth | ≤3 | 4 |
| Function arguments | ≤3 | 5 |
References
| Topic | File |
|---|---|
| Control Flow | references/control-flow.md |
| Comments | references/comments-clarity.md |
| AI Antipatterns | references/ai-antipatterns.md |
| Naming | references/naming.md |
Examples
Read the usage examples in the source repository.
View source ↗Source history
- Indexed on
- 2026-01-20
- Index updated
- 2026-01-26
- Branch
- main
Index and sync dates describe this directory. View the source repository for code history.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!