All skills
secondsky avatar

/claude-md-improver

@9816df2
by Eddiesecondsky/sap-skills456 stars
120

Audit and improve CLAUDE.md files in repositories. Use when user asks to check, audit, update, improve, or fix CLAUDE.md files. Scans for all CLAUDE.md files, evaluates quality against templates, outputs quality report, then makes targeted updates. Also use when the user mentions "CLAUDE.md maintenance" or "project memory optimization".

Use this Skill: https://skilld.dev/gh/secondsky/sap-skills/claude-md-improver

This session only. Nothing lands on disk.

referencesquality-criteria.md

≈655 tokens on demand. Your agent reads this file only when SKILL.md points to it.

CLAUDE.md Quality Criteria

Scoring Rubric

1. Commands/Workflows (20 points)

20 points: All essential commands documented with context

  • Build, test, lint, deploy commands present
  • Development workflow clear
  • Common operations documented

15 points: Most commands present, some missing context

10 points: Basic commands only, no workflow

5 points: Few commands, many missing

0 points: No commands documented

2. Architecture Clarity (20 points)

20 points: Clear codebase map

  • Key directories explained
  • Module relationships documented
  • Entry points identified
  • Data flow described where relevant

15 points: Good structure overview, minor gaps

10 points: Basic directory listing only

5 points: Vague or incomplete

0 points: No architecture info

3. Non-Obvious Patterns (15 points)

15 points: Gotchas and quirks captured

  • Known issues documented
  • Workarounds explained
  • Edge cases noted
  • "Why we do it this way" for unusual patterns

10 points: Some patterns documented

5 points: Minimal pattern documentation

0 points: No patterns or gotchas

4. Conciseness (15 points)

15 points: Dense, valuable content

  • No filler or obvious info
  • Each line adds value
  • No redundancy with code comments

10 points: Mostly concise, some padding

5 points: Verbose in places

0 points: Mostly filler or restates obvious code

5. Currency (15 points)

15 points: Reflects current codebase

  • Commands work as documented
  • File references accurate
  • Tech stack current

10 points: Mostly current, minor staleness

5 points: Several outdated references

0 points: Severely outdated

6. Actionability (15 points)

15 points: Instructions are executable

  • Commands can be copy-pasted
  • Steps are concrete
  • Paths are real

10 points: Mostly actionable

5 points: Some vague instructions

0 points: Vague or theoretical

Assessment Process

  1. Read the CLAUDE.md file completely
  2. Cross-reference with actual codebase:
    • Run documented commands (mentally or actually)
    • Check if referenced files exist
    • Verify architecture descriptions
  3. Score each criterion
  4. Calculate total and assign grade
  5. List specific issues found
  6. Propose concrete improvements

Red Flags

  • Commands that would fail (wrong paths, missing deps)
  • References to deleted files/folders
  • Outdated tech versions
  • Copy-paste from templates without customization
  • Generic advice not specific to the project
  • "TODO" items never completed
  • Duplicate info across multiple CLAUDE.md files

Source: SKILL.md on GitHub

No alerts3mo3 checks · Risk SAFE
  • Gen Agent Trust Hub3mo

    The skill facilitates the auditing and improvement of project-specific documentation (CLAUDE.md files). While it uses standard tools, a security concern is present in the assessment guidelines, which suggest that the agent should verify documented commands by 'actually' running them. This creates a risk of executing malicious commands if they are embedded in the files being audited.

  • Socket3mo

    No alerts

  • Snyk3mo

    Risk: LOW · No issues

Signed by skilld at 9816df2. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 2 weeks ago.

Activeupdated 4 months ago
tools
Read, Glob, Grep, Bash, Edit

README badge

README badge for secondsky/sap-skills/claude-md-improver