Skills
.Work. You
Rest

repo-doc-audit

Official

Full repo docs health audit for consistency.

Content & Communication#architecture#documentation#audit#readme#scripts#repo-health
AuthorOpen-Earth-Foundation
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill performs a targeted, one-off audit of a repository's documentation to identify gaps, inconsistencies, and outdated information across docstrings, README files, architecture notes, and scripting conventions.

Core Features & Use Cases

  • Assess README accuracy and completeness, ensuring commands, setup steps, and troubleshooting align with the codebase.
  • Validate architecture and component references against the actual repository structure.
  • Audit script and module docstrings to improve clarity and onboarding.
  • Generate an actionable report with prioritized fixes and suggested edits.

Quick Start

Run the repo-doc-audit skill to generate a full documentation health report for the repository, focusing on README accuracy, architecture references, and script docstrings.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: repo-doc-audit
Download link: https://github.com/Open-Earth-Foundation/CityCatalyst/archive/main.zip#repo-doc-audit

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.