Initial commit
This commit is contained in:
131
skills/claude-md-auditor/examples/sample_audit_report.md
Normal file
131
skills/claude-md-auditor/examples/sample_audit_report.md
Normal file
@@ -0,0 +1,131 @@
|
||||
# CLAUDE.md Audit Report
|
||||
|
||||
**File**: `/Users/connor/.claude/CLAUDE.md`
|
||||
|
||||
**Generated**: 2025-10-26 09:32:18
|
||||
|
||||
**Tier**: Project
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
## Executive Summary
|
||||
|
||||
| Metric | Value |
|
||||
|--------|-------|
|
||||
| **Overall Health** | 91/100 (Excellent) |
|
||||
| **Status** | ✅ **HEALTHY** - Minor optimizations available |
|
||||
| **Critical Issues** | 0 |
|
||||
| **High Priority** | 0 |
|
||||
| **Medium Priority** | 1 |
|
||||
| **Low Priority** | 2 |
|
||||
| **Total Findings** | 3 |
|
||||
|
||||
## Score Dashboard
|
||||
|
||||
| Category | Score | Status |
|
||||
|----------|-------|--------|
|
||||
| **Security** | 100/100 | ✅ Excellent |
|
||||
| **Official Compliance** | 100/100 | ✅ Excellent |
|
||||
| **Best Practices** | 100/100 | ✅ Excellent |
|
||||
| **Research Optimization** | 97/100 | ✅ Excellent |
|
||||
|
||||
## File Metrics
|
||||
|
||||
| Metric | Value | Recommendation |
|
||||
|--------|-------|----------------|
|
||||
| **Lines** | 167 | 100-300 lines ideal |
|
||||
| **Characters** | 6,075 | Keep concise |
|
||||
| **Est. Tokens** | 1,518 | < 3,000 recommended |
|
||||
| **Context Usage (200K)** | 0.76% | < 2% ideal |
|
||||
| **Context Usage (1M)** | 0.15% | Reference only |
|
||||
|
||||
✅ **Assessment**: File length is in optimal range (100-300 lines).
|
||||
|
||||
## Findings
|
||||
|
||||
| Severity | Count | Description |
|
||||
|----------|-------|-------------|
|
||||
| 🚨 **Critical** | 0 | Security risks, immediate action required |
|
||||
| ⚠️ **High** | 0 | Significant issues, fix this sprint |
|
||||
| 📋 **Medium** | 1 | Moderate issues, schedule for next quarter |
|
||||
| ℹ️ **Low** | 2 | Minor improvements, backlog |
|
||||
|
||||
## Findings by Category
|
||||
|
||||
| Category | Count | Description |
|
||||
|----------|-------|-------------|
|
||||
| **Security** | 0 | Security vulnerabilities and sensitive information |
|
||||
| **Official Compliance** | 0 | Compliance with official Anthropic documentation |
|
||||
| **Best Practices** | 0 | Community best practices and field experience |
|
||||
| **Research Optimization** | 1 | Research-based optimizations (lost in the middle, etc.) |
|
||||
| **Structure** | 1 | Document structure and organization |
|
||||
| **Maintenance** | 1 | Maintenance indicators and staleness |
|
||||
|
||||
## Detailed Findings
|
||||
|
||||
|
||||
### 📋 MEDIUM Priority
|
||||
|
||||
#### 1. Potentially Broken File Paths
|
||||
|
||||
**Category**: Maintenance
|
||||
**Source**: Community Guidance
|
||||
|
||||
**Description**: Found 13 file paths that may not exist
|
||||
|
||||
**Impact**: Broken paths mislead developers and indicate stale documentation
|
||||
|
||||
**Remediation**:
|
||||
Verify all file paths and update or remove broken ones
|
||||
|
||||
---
|
||||
|
||||
|
||||
### ℹ️ LOW Priority
|
||||
|
||||
#### 1. Minimal Organization
|
||||
|
||||
**Category**: Structure
|
||||
**Source**: Community Guidance
|
||||
|
||||
**Description**: Only 0 main sections found
|
||||
|
||||
**Impact**: May lack clear structure
|
||||
|
||||
**Remediation**:
|
||||
Organize into sections: Standards, Workflow, Commands, Reference
|
||||
|
||||
---
|
||||
|
||||
#### 2. Critical Content in Middle Position
|
||||
|
||||
**Category**: Research Optimization
|
||||
**Source**: Research Guidance
|
||||
|
||||
**Description**: Most critical standards appear in middle section
|
||||
|
||||
**Impact**: Research shows 'lost in the middle' attention pattern. Critical info at top/bottom gets more attention.
|
||||
|
||||
**Remediation**:
|
||||
Move must-follow standards to top section. Move reference info to bottom. Keep nice-to-have in middle.
|
||||
|
||||
---
|
||||
|
||||
|
||||
## Priority Recommendations
|
||||
|
||||
### 💡 General Recommendations
|
||||
|
||||
- **Regular maintenance**: Schedule quarterly CLAUDE.md reviews
|
||||
- **Team collaboration**: Share CLAUDE.md improvements via PR
|
||||
- **Validate effectiveness**: Test that Claude follows standards without prompting
|
||||
|
||||
---
|
||||
|
||||
|
||||
*Generated by claude-md-auditor v1.0.0*
|
||||
|
||||
*Based on official Anthropic documentation, community best practices, and academic research*
|
||||
|
||||
Reference in New Issue
Block a user