archivist-readability-auditor

Identify readability issues in codebases and generate audit reports.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/rfowler1994/project-archivist --skill archivist-readability-auditor
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: archivist-readability-auditor
Source: https://github.com/rfowler1994/project-archivist/tree/main/.agents/skills/archivist-readability-auditor
Command: npx skills add https://github.com/rfowler1994/project-archivist --skill archivist-readability-auditor

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Report-only Project Archivist audit for maintainability and readability issues. Use when asked to find long files, unclear names, deeply nested logic, mixed responsibilities, hard-to-scan components, missing comments around non-obvious logic, outdated comments, magic numbers, or unclear control flow.

Core Features & Use Cases

  • Identify long files and deeply nested logic that slow development.
  • Flag unclear names for files, functions, variables, components, or concepts.
  • Produce standardized audit reports under docs/code-audits/reports/ to support refactoring and documentation.

Quick Start

Run a focused audit over the codebase to surface readability issues and generate a report under docs/code-audits/reports/.

Frequently Asked Questions about archivist-readability-auditor

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

FAQPage Schema
How do I audit my codebase for readability and maintainability issues?

Run a static analysis pass over your codebase to identify readability problems like long files, unclear identifiers, nested logic, and mixed responsibilities, generating standardized reports under the code-audits directory.

What readability problems commonly slow down development in large repositories?

Long files, unclear names, deeply nested logic, mixed responsibilities, hard-to-scan components, missing or outdated comments, magic numbers, and unclear control flow are common readability problems that slow development in large repositories.

Can I generate maintainability reports without modifying my source code?

Yes, you can generate maintainability reports without modifying source code by running a report-only audit that stores findings with precise source file references under the docs/code-audits/reports/ directory.

How do I track code quality findings during a maintainability audit?

Track code quality findings by generating standardized FINDING IDs in the READ-### format, stored alongside precise source file references in reports under the docs/code-audits/reports/ directory.

Does this readability audit work on large repositories with mixed responsibilities?

Yes, this readability audit applies to large repositories requiring maintainability audits and specifically targets mixed responsibilities, deeply nested logic, and long files to surface issues and speed up development.

What is the best way to identify unclear identifiers and magic numbers in a codebase?

Run a focused readability audit that flags unclear names for files, functions, variables, and components, and identifies magic numbers, producing a standardized report to support documentation and refactoring.