# Improve Code Readability

Teams often write code that only developers can follow. This skill checks names, comments, jargon, and documentation so broader teams can understand code faster.

## Install

```bash
npx skillstore add abereyes/abejitsu-code-analysis
```

## Metadata

- - Status: approved
- - Slug: abejitsu-code-analysis
- - Version: 1.0.0
- - Author: abereyes
- - GitHub username: AbeJitsu
- - License: MIT
- - Repository: https://github.com/AbeJitsu/Learn-Claude-Code/tree/main/skills/code-analysis
- - Ref: main
- - Supported tools: Claude, Codex, Claude Code
- - Risk level: low
- - Risk factors: scripts, filesystem, external\_commands
- - Quality score: 77
- - Quality tier: bronze
- - Public page: https://skillstore.pages.dev/skills/abejitsu-code-analysis
- - Manifest: https://skillstore.pages.dev/api/skills/abejitsu-code-analysis/manifest

## Capabilities

- Scores readability for supported source files.
- Flags cryptic variable and function names.
- Checks comment coverage and long uncommented sections.
- Finds unexplained technical jargon in comments.
- Checks functions and classes for What, Why, and How documentation.
- Outputs human-readable or JSON-formatted reports.

## Use Cases

- Review stakeholder-facing code: Check whether business logic has clear names and plain comments before a product review.
- Prepare onboarding examples: Find missing explanations before sharing code with new team members.
- Improve documentation quality: Identify jargon and missing What, Why, and How context in source comments.

## Prompt Templates

### Check one file

```
Use the code-analysis skill to review this file for non-developer readability: [file path].
```

### Focus on naming

```
Analyze [file path] with focus on naming. Explain which names should be clearer and why.
```

### Prepare for onboarding

```
Review [file path] for a new team member. Prioritize comments, jargon, and missing context.
```

### Run strict readiness review

```
Analyze [file path] with strict readability expectations. Summarize blockers before this code is shared with stakeholders.
```

## Limitations

- Only supports Python, JavaScript, TypeScript, Java, Go, Ruby, and PHP extensions.
- It reads local files selected by the user.
- It can produce false positives in examples or generated code.
- It measures readability patterns, not code correctness or security.

## Best Practices

- Run it on intended project files, not files that contain secrets.
- Use strict mode before sharing code with non-developer audiences.
- Review each suggestion manually before changing established domain terms.

## Anti Patterns

- Do not treat the score as proof that the code is correct.
- Do not scan private credentials, keys, or sensitive configuration files.
- Do not replace human documentation review with automated findings alone.

## Security Audit

- - Safe to publish: true
- - Audited at: 2026-06-28T04:09:30.563\+00:00
- - Summary: The static weak cryptography findings are false positives caused by readability terms such as token, serialize, and hash-related wording, not cryptographic operations. The Markdown backtick findings are also false positives from fenced examples and documented CLI usage. The skill is safe to publish with a low warning because it runs a local script that reads user-selected files and may print code snippets.

## Stats

- - Views: 197
- - Downloads: 8
- - Favorites: 0
- - Popularity score: 0