Initial commit
This commit is contained in:
507
commands/workspace/distribution-ready.md
Normal file
507
commands/workspace/distribution-ready.md
Normal file
@@ -0,0 +1,507 @@
|
||||
---
|
||||
name: workspace:distribution-ready
|
||||
description: Clean and optimize repository for marketplace/public distribution
|
||||
delegates-to: autonomous-agent:workspace-organizer
|
||||
---
|
||||
|
||||
# Command: `/workspace:distribution-ready`
|
||||
|
||||
**Prepares the repository for public marketplace distribution** by removing all computer-specific files, local patterns, performance data, and unnecessary files while preserving local functionality.
|
||||
|
||||
## Purpose
|
||||
|
||||
- Clean repository for public marketplace distribution
|
||||
- Remove computer-specific files and local data
|
||||
- Optimize repository structure for plugin marketplace
|
||||
- Preserve local functionality while cleaning remote repository
|
||||
- Ensure cross-platform compatibility
|
||||
|
||||
## What It Does
|
||||
|
||||
### 1. **Repository Analysis** (5-10 seconds)
|
||||
- Scan repository for computer-specific files
|
||||
- Identify local patterns and performance data
|
||||
- Detect unnecessary files for marketplace
|
||||
- Analyze current .gitignore coverage
|
||||
|
||||
### 2. **File Classification** (10-15 seconds)
|
||||
- **Essential Files**: Plugin core functionality (agents, skills, commands, lib)
|
||||
- **Computer-Specific**: .claude*, .reports, local patterns, performance data
|
||||
- **Local Development**: improvements/, patterns/, generated reports
|
||||
- **Marketplace Ready**: Documentation, plugin manifest, core components
|
||||
|
||||
### 3. **Git Repository Cleanup** (30-60 seconds)
|
||||
- Remove computer-specific files from Git tracking
|
||||
- Update .gitignore with comprehensive exclusions
|
||||
- Clean repository while preserving local files
|
||||
- Optimize for public distribution
|
||||
|
||||
### 4. **Structure Verification** (10-15 seconds)
|
||||
- Verify all 22 agents are present and functional
|
||||
- Confirm 17 skills are accessible
|
||||
- Validate 39 commands are properly structured
|
||||
- Check 140+ Python scripts for cross-platform compatibility
|
||||
|
||||
### 5. **Marketplace Readiness Check** (15-20 seconds)
|
||||
- Validate plugin manifest completeness
|
||||
- Check essential documentation presence
|
||||
- Verify repository size optimization
|
||||
- Confirm privacy and security compliance
|
||||
|
||||
## Key Features
|
||||
|
||||
### **Smart File Preservation**
|
||||
```
|
||||
Computer-Specific Files (Removed from tracking, kept locally):
|
||||
+- .claude*/ # Claude AI local directories
|
||||
+- .reports*/ # Local reports and data
|
||||
+- improvements/ # Local improvement analysis
|
||||
+- patterns/ # Local auto-fix patterns
|
||||
+- *performance*.json # Performance metrics
|
||||
+- *metrics*.json # Local metrics
|
||||
+- quality_history*.json # Quality tracking
|
||||
+- Generated release notes # Local changelogs
|
||||
|
||||
Essential Files (Kept in repository):
|
||||
+- agents/ # 22 specialized agents
|
||||
+- skills/ # 17 knowledge packages
|
||||
+- commands/ # 39 slash commands
|
||||
+- lib/ # 140+ Python utilities
|
||||
+- .claude-plugin/ # Plugin manifest
|
||||
+- docs/ # Essential documentation
|
||||
+- README.md # Main documentation
|
||||
+- assets/ # Plugin assets
|
||||
```
|
||||
|
||||
### **Enhanced Gitignore Protection**
|
||||
```gitignore
|
||||
# Claude AI local directories (computer-specific)
|
||||
.claude/
|
||||
.claude-patterns/
|
||||
.claude-unified/
|
||||
.claude-preferences/
|
||||
.claude-quality/
|
||||
.claude-test/
|
||||
data/reports/
|
||||
.claudedata/reports/
|
||||
|
||||
# User-specific reports and data
|
||||
.data/reports/
|
||||
.reportscurrent/
|
||||
.reportscurrentvalidation/
|
||||
|
||||
# Local patterns and performance data (computer-specific)
|
||||
patterns/
|
||||
improvements/
|
||||
local_config.json
|
||||
user_settings.json
|
||||
*performance*.json
|
||||
*metrics*.json
|
||||
quality_history*.json
|
||||
debugging_performance*.json
|
||||
dashboard_*.json
|
||||
*_backup*
|
||||
|
||||
# Temporary and backup files
|
||||
*.tmp
|
||||
*.log
|
||||
*.backup
|
||||
*~
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
|
||||
# OS generated files
|
||||
lib/__pycache__/
|
||||
__pycache__/
|
||||
*.pyc
|
||||
*.pyo
|
||||
|
||||
# Test files (local only)
|
||||
dashboard_test.html
|
||||
*.test.*
|
||||
test_.*
|
||||
|
||||
# Local development files
|
||||
.env.local
|
||||
.env.local.*
|
||||
local_settings.json
|
||||
settings.local.json
|
||||
|
||||
# Generated reports (keep structure, clean content)
|
||||
data/reports/generated/*
|
||||
!data/reports/generated/.gitkeep
|
||||
|
||||
# Python cache and environment
|
||||
*.egg-info/
|
||||
.venv/
|
||||
venv/
|
||||
env/
|
||||
ENV/
|
||||
```
|
||||
|
||||
### **Cross-Platform Compatibility**
|
||||
- ✅ Windows path compatibility
|
||||
- ✅ Linux/Unix compatibility
|
||||
- ✅ macOS compatibility
|
||||
- ✅ Python scripts work across platforms
|
||||
- ✅ File locking handled properly
|
||||
|
||||
### **Automatic Learning Integration**
|
||||
The command integrates with the pattern learning system:
|
||||
- **Store distribution patterns**: Record successful repository cleaning patterns
|
||||
- **Learn optimization**: Improve file classification over time
|
||||
- **Track effectiveness**: Monitor distribution success rates
|
||||
- **Share patterns**: Cross-project distribution knowledge
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### **Basic Usage**
|
||||
```bash
|
||||
# Prepare repository for marketplace distribution
|
||||
/workspace:distribution-ready
|
||||
|
||||
# Include verbose output
|
||||
/workspace:distribution-ready --verbose
|
||||
|
||||
# Dry run to see what would be removed
|
||||
/workspace:distribution-ready --dry-run
|
||||
```
|
||||
|
||||
### **Advanced Options**
|
||||
```bash
|
||||
# Prepare with specific file preservation
|
||||
/workspace:distribution-ready --keep "custom-data/"
|
||||
|
||||
# Force cleanup of additional patterns
|
||||
/workspace:distribution-ready --aggressive
|
||||
|
||||
# Create backup before cleanup
|
||||
/workspace:distribution-ready --backup
|
||||
|
||||
# Skip confirmation prompts
|
||||
/workspace:distribution-ready --force
|
||||
```
|
||||
|
||||
### **Analysis Mode**
|
||||
```bash
|
||||
# Analyze only, don't make changes
|
||||
/workspace:distribution-ready --analyze-only
|
||||
|
||||
# Show detailed file classification
|
||||
/workspace:distribution-ready --classification
|
||||
|
||||
# Generate cleanup report
|
||||
/workspace:distribution-ready --report
|
||||
```
|
||||
|
||||
## Output Format
|
||||
|
||||
### **Terminal Output (Concise)**
|
||||
|
||||
```
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
📦 MARKETPLACE DISTRIBUTION PREPARATION
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
|
||||
Repository Analysis Complete
|
||||
Files Scanned: 340
|
||||
Essential Files: 304
|
||||
Computer-Specific: 36
|
||||
|
||||
Cleanup Strategy: Optimize for marketplace
|
||||
|
||||
Files to Remove from Tracking:
|
||||
+- .claude-patterns/ (23 files)
|
||||
+- improvements/ (3 files)
|
||||
+- patterns/ (1 file)
|
||||
+- Generated reports (9 files)
|
||||
+- Performance data (12 files)
|
||||
|
||||
Local Files Preserved: ✅ All 36 files
|
||||
Git Protection: ✅ Enhanced .gitignore
|
||||
Cross-Platform: ✅ Verified
|
||||
|
||||
Execute cleanup? [Y/n]: Y
|
||||
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
✅ DISTRIBUTION READY
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
|
||||
[PASS] Repository cleaned for marketplace distribution
|
||||
[PASS] 36 computer-specific files removed from tracking
|
||||
[PASS] 304 essential files preserved
|
||||
[PASS] Enhanced gitignore protection implemented
|
||||
[PASS] Cross-platform compatibility verified
|
||||
|
||||
Final Repository: 304 files (11MB reduction)
|
||||
Ready for: Marketplace distribution and GitHub release
|
||||
|
||||
⏱ Completed in 2 minutes 15 seconds
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
```
|
||||
|
||||
### **Detailed Report File**
|
||||
|
||||
```
|
||||
📄 Detailed report: .claude/data/reports/distribution-ready-2025-10-30.md
|
||||
```
|
||||
|
||||
## File Classification Details
|
||||
|
||||
### **Essential Files (Preserved)**
|
||||
- **Plugin Core**: agents/, skills/, commands/, lib/
|
||||
- **Documentation**: README.md, docs/, assets/
|
||||
- **Configuration**: .claude-plugin/, .github/workflows/
|
||||
- **Templates**: Essential templates and examples
|
||||
- **Utilities**: Core Python scripts and tools
|
||||
|
||||
### **Computer-Specific Files (Removed from Tracking)**
|
||||
- **Local Patterns**: .claude-patterns/ (all JSON files)
|
||||
- **Performance Data**: quality history, metrics, debugging data
|
||||
- **Local Reports**: .data/reports/, validation reports
|
||||
- **Development Files**: improvements/, patterns/, test files
|
||||
- **Generated Content**: Release notes, changelogs, generated docs
|
||||
|
||||
### **Protected but Local**
|
||||
- All removed files remain available locally
|
||||
- Accessible for continued development and testing
|
||||
- Automatically excluded from future commits
|
||||
- Preserved across system reboots and updates
|
||||
|
||||
## Integration with Existing Commands
|
||||
|
||||
### **Development Workflow**
|
||||
```bash
|
||||
# Complete development work
|
||||
/dev:commit --auto
|
||||
|
||||
# Prepare for marketplace release
|
||||
/workspace:distribution-ready
|
||||
|
||||
# Create release
|
||||
/dev:release
|
||||
|
||||
# Validate plugin readiness
|
||||
/validate:plugin
|
||||
```
|
||||
|
||||
### **Quality Assurance**
|
||||
```bash
|
||||
# Check code quality
|
||||
/analyze:quality
|
||||
|
||||
# Prepare repository
|
||||
/workspace:distribution-ready
|
||||
|
||||
# Validate full structure
|
||||
/validate:all
|
||||
|
||||
# Test plugin functionality
|
||||
/debug:eval plugin-installation-test
|
||||
```
|
||||
|
||||
### **Continuous Integration**
|
||||
```bash
|
||||
# Automated cleanup in CI/CD
|
||||
/workspace:distribution-ready --force
|
||||
|
||||
# Validate structure
|
||||
/validate:fullstack
|
||||
|
||||
# Run tests
|
||||
/test:comprehensive
|
||||
```
|
||||
|
||||
## Learning System Integration
|
||||
|
||||
### **Pattern Storage**
|
||||
```json
|
||||
{
|
||||
"distribution_patterns": {
|
||||
"computer_specific_files": [
|
||||
".claude-patterns/*.json",
|
||||
"improvements/*.json",
|
||||
"patterns/*.json",
|
||||
"*performance*.json"
|
||||
],
|
||||
"essential_directories": [
|
||||
"agents/",
|
||||
"skills/",
|
||||
"commands/",
|
||||
"lib/",
|
||||
"docs/"
|
||||
],
|
||||
"gitignore_patterns": [
|
||||
".claude*",
|
||||
".reports*",
|
||||
"*performance*",
|
||||
"*metrics*"
|
||||
],
|
||||
"success_rate": 0.98,
|
||||
"avg_cleanup_time": 135,
|
||||
"file_preservation_accuracy": 1.0
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### **Continuous Improvement**
|
||||
- **File Classification Learning**: Improve file type recognition
|
||||
- **Cleanup Strategy Optimization**: Learn optimal cleanup approaches
|
||||
- **Cross-Project Patterns**: Share successful distribution patterns
|
||||
- **Effectiveness Tracking**: Monitor distribution success rates
|
||||
|
||||
## Best Practices
|
||||
|
||||
### **When to Use**
|
||||
✅ **Before marketplace submission**
|
||||
✅ **Before GitHub releases**
|
||||
✅ **Before plugin distribution**
|
||||
✅ **After major development cycles**
|
||||
✅ **When repository size becomes an issue**
|
||||
|
||||
### **What Gets Preserved**
|
||||
✅ **All plugin functionality** - Commands work identically
|
||||
✅ **Learning capabilities** - Pattern learning preserved locally
|
||||
✅ **Cross-platform compatibility** - All scripts work
|
||||
✅ **Development workflow** - Local development unaffected
|
||||
✅ **Performance tracking** - Local metrics preserved
|
||||
|
||||
### **What Gets Removed**
|
||||
❌ **Computer-specific patterns** (preserved locally, not tracked)
|
||||
❌ **Performance metrics** (preserved locally, not tracked)
|
||||
❌ **Local reports** (preserved locally, not tracked)
|
||||
❌ **Generated content** (preserved locally, not tracked)
|
||||
❌ **Development artifacts** (preserved locally, not tracked)
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### **Common Issues**
|
||||
|
||||
**Repository not clean enough**
|
||||
```bash
|
||||
# Run with aggressive mode
|
||||
/workspace:distribution-ready --aggressive
|
||||
|
||||
# Manually review remaining files
|
||||
/workspace:distribution-ready --classification
|
||||
```
|
||||
|
||||
**Essential files accidentally removed**
|
||||
```bash
|
||||
# Restore from Git history
|
||||
git checkout HEAD~1 -- path/to/essential/file
|
||||
|
||||
# Check what was removed
|
||||
git log --name-status -5
|
||||
```
|
||||
|
||||
**Local files missing after cleanup**
|
||||
```bash
|
||||
# Verify local files still exist
|
||||
ls -la .claude-patterns/ improvements/ patterns/
|
||||
|
||||
# Check gitignore protection
|
||||
git status --ignored
|
||||
```
|
||||
|
||||
### **Recovery Options**
|
||||
```bash
|
||||
# Undo all changes (if needed)
|
||||
git reset --hard HEAD~1
|
||||
|
||||
# Restore specific directories
|
||||
git checkout HEAD~1 -- improvements/ patterns/
|
||||
|
||||
# Generate new patterns
|
||||
/workspace:organize --regenerate-patterns
|
||||
```
|
||||
|
||||
## Performance Metrics
|
||||
|
||||
Expected performance:
|
||||
|
||||
| Task | Time | Success Rate |
|
||||
|------|------|--------------|
|
||||
| Repository analysis | 5-10s | 100% |
|
||||
| File classification | 10-15s | 98% |
|
||||
| Git cleanup | 30-60s | 95% |
|
||||
| Structure verification | 10-15s | 99% |
|
||||
| Marketplace validation | 15-20s | 97% |
|
||||
|
||||
**Repository Size Reduction**: 10-15MB average
|
||||
**File Count Optimization**: 30-50 files removed
|
||||
**Learning Improvement**: 25% faster classification after 5 uses
|
||||
|
||||
## Examples
|
||||
|
||||
### **Example 1: Standard Distribution Prep**
|
||||
```bash
|
||||
$ /workspace:distribution-ready
|
||||
|
||||
Scanning repository...
|
||||
Found: 340 files total, 36 computer-specific
|
||||
|
||||
Classification:
|
||||
[PASS] Essential: 304 files (agents, skills, commands, lib)
|
||||
[PASS] Computer-specific: 36 files (patterns, metrics, reports)
|
||||
|
||||
Cleanup complete:
|
||||
- Removed 36 files from tracking
|
||||
- Enhanced .gitignore protection
|
||||
- Preserved all local functionality
|
||||
- Ready for marketplace distribution
|
||||
|
||||
Result: ✅ Distribution ready (304 files, 12MB reduction)
|
||||
```
|
||||
|
||||
### **Example 2: Analysis Mode**
|
||||
```bash
|
||||
$ /workspace:distribution-ready --analyze-only
|
||||
|
||||
Repository Analysis Report:
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
|
||||
Essential Components ([PASS] Keep):
|
||||
+- agents/ (22 files) - Core plugin functionality
|
||||
+- skills/ (17 files) - Knowledge packages
|
||||
+- commands/ (39 files) - Slash commands
|
||||
+- lib/ (140 files) - Python utilities
|
||||
+- docs/ (15 files) - Essential documentation
|
||||
|
||||
Computer-Specific Files (🗑 Remove from tracking):
|
||||
+- .claude-patterns/ (23 files) - Local patterns
|
||||
+- improvements/ (3 files) - Local improvements
|
||||
+- patterns/ (1 file) - Auto-fix patterns
|
||||
+- Generated content (9 files) - Reports/changelogs
|
||||
|
||||
Recommendation: Ready for marketplace distribution cleanup
|
||||
```
|
||||
|
||||
### **Example 3: Aggressive Cleanup**
|
||||
```bash
|
||||
$ /workspace:distribution-ready --aggressive --force
|
||||
|
||||
Aggressive cleanup mode enabled...
|
||||
Additional patterns detected:
|
||||
+- *.log files (5)
|
||||
+- *.backup files (8)
|
||||
+- Cache directories (3)
|
||||
+- Temporary artifacts (12)
|
||||
|
||||
Executing comprehensive cleanup...
|
||||
[PASS] Standard cleanup: 36 files removed
|
||||
[PASS] Aggressive cleanup: 28 additional files removed
|
||||
[PASS] Total optimization: 64 files removed
|
||||
[PASS] Repository size reduction: 18MB
|
||||
|
||||
Marketplace ready: ✅ Optimized for distribution
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**Version**: 1.0.0
|
||||
**Integration**: Uses workspace-organizer, git-repository-manager agents
|
||||
**Skills**: git-automation, pattern-learning, code-analysis, validation-standards
|
||||
**Platform**: Cross-platform (Windows, Linux, Mac)
|
||||
**Learning**: Full integration with pattern learning system
|
||||
**Scope**: Repository optimization for marketplace distribution only
|
||||
499
commands/workspace/improve.md
Normal file
499
commands/workspace/improve.md
Normal file
@@ -0,0 +1,499 @@
|
||||
---
|
||||
name: workspace:improve
|
||||
description: Analyze plugin and suggest improvements based on best practices and patterns
|
||||
delegates-to: autonomous-agent:orchestrator
|
||||
---
|
||||
|
||||
# Improve Plugin Command
|
||||
|
||||
## Command: `/workspace:improve`
|
||||
|
||||
Analyzes user interactions with the autonomous agent plugin and automatically generates structured improvement prompts for continuous plugin development. This command implements the key innovation of automatic learning by transforming user experiences into actionable development insights.
|
||||
|
||||
## Purpose
|
||||
|
||||
The `/improve-plugin` command serves as a bridge between user experiences and plugin evolution. It systematically analyzes how users interact with the plugin, identifies patterns, generates improvement suggestions, and stores them in a unified format that can drive continuous development.
|
||||
|
||||
## How It Works
|
||||
|
||||
### 1. Experience Data Collection
|
||||
|
||||
**Sources Analyzed**:
|
||||
- **Pattern Database**: Task execution patterns and outcomes
|
||||
- **Performance Metrics**: Quality scores, success rates, time efficiency
|
||||
- **Usage Patterns**: Command frequency, skill utilization, agent delegation
|
||||
- **Error Logs**: Common failures and recovery patterns
|
||||
- **Feedback Traces**: Implicit feedback from task outcomes
|
||||
- **Learning Evolution**: How performance has improved over time
|
||||
|
||||
### 2. Pattern Recognition
|
||||
|
||||
**Analysis Dimensions**:
|
||||
- **Effectiveness Patterns**: Which approaches consistently succeed
|
||||
- **Efficiency Patterns**: Time-to-resolution trends
|
||||
- **Error Patterns**: Common failure modes and their contexts
|
||||
- **Learning Patterns**: Skill acquisition and improvement rates
|
||||
- **Usage Patterns**: Command popularity and feature utilization
|
||||
- **Quality Patterns**: Factors influencing task quality scores
|
||||
|
||||
### 3. Improvement Prompt Generation
|
||||
|
||||
**Prompt Types Generated**:
|
||||
- **Feature Enhancement**: New functionality suggestions based on usage gaps
|
||||
- **Performance Optimization**: Speed and efficiency improvements
|
||||
- **User Experience**: Workflow and interface improvements
|
||||
- **Error Prevention**: Proactive measures to reduce common failures
|
||||
- **Learning Enhancement**: Pattern recognition and knowledge transfer improvements
|
||||
- **Integration Opportunities**: Ways to better connect components
|
||||
|
||||
### 4. Unified Storage System
|
||||
|
||||
**Storage Location**: `./improvements/unified-improvements.json`
|
||||
|
||||
**JSON Structure**:
|
||||
```json
|
||||
{
|
||||
"analysis_id": "exp_analysis_2025_10_25_16_35_42",
|
||||
"timestamp": "2025-10-25T16:35:42.123Z",
|
||||
"model_used": "Claude Sonnet 4.5",
|
||||
"analysis_scope": {
|
||||
"timeframe": "last_30_days",
|
||||
"data_sources": ["patterns", "performance", "usage", "errors"],
|
||||
"total_patterns_analyzed": 47,
|
||||
"performance_records_analyzed": 12,
|
||||
"command_usage_analyzed": 89
|
||||
},
|
||||
"key_findings": {
|
||||
"top_success_patterns": [
|
||||
{
|
||||
"pattern_type": "bug_fix",
|
||||
"success_rate": 0.95,
|
||||
"avg_quality_score": 92,
|
||||
"common_approach": "systematic_error_analysis + pattern matching"
|
||||
}
|
||||
],
|
||||
"improvement_opportunities": [
|
||||
{
|
||||
"area": "debugging_performance",
|
||||
"current_score": 87,
|
||||
"potential_improvement": 15,
|
||||
"suggested_approach": "enhanced_error_pattern matching"
|
||||
}
|
||||
]
|
||||
},
|
||||
"improvement_prompts": [
|
||||
{
|
||||
"id": "improve_debugging_speed",
|
||||
"priority": "high",
|
||||
"category": "performance",
|
||||
"prompt": "Based on analyzing 47 debugging tasks, implement pattern-based error detection that reduces average resolution time from 8.2 minutes to under 5 minutes. Focus on common error patterns: JavaScript ReferenceErrors, missing variables in destructuring, and API integration issues.",
|
||||
"evidence": {
|
||||
"sample_size": 47,
|
||||
"current_performance": "8.2 min avg",
|
||||
"target_performance": "<5 min avg",
|
||||
"success_rate_impact": "Could improve from 87% to 95%"
|
||||
}
|
||||
}
|
||||
],
|
||||
"usage_insights": {
|
||||
"most_used_commands": [
|
||||
{"command": "/auto-analyze", "usage_count": 23, "success_rate": 0.91},
|
||||
{"command": "/dashboard", "usage_count": 18, "success_rate": 1.0},
|
||||
{"command": "/eval-debug", "usage_count": 12, "success_rate": 0.92}
|
||||
],
|
||||
"least_used_features": [
|
||||
{"feature": "workspace organization", "usage_count": 3, "potential": "high"},
|
||||
{"feature": "pattern validation", "usage_count": 5, "potential": "medium"}
|
||||
]
|
||||
},
|
||||
"learning_trends": {
|
||||
"quality_improvement_rate": "+0.8 points per week",
|
||||
"speed_improvement_rate": "-12% time per task per week",
|
||||
"pattern_utilization_efficiency": "+5% per week",
|
||||
"areas_needing_attention": ["cross-project pattern transfer", "error prediction"]
|
||||
},
|
||||
"next_steps": {
|
||||
"immediate_actions": [
|
||||
"Implement debugging pattern database",
|
||||
"Enhance error prediction capabilities",
|
||||
"Create cross-project learning transfer"
|
||||
],
|
||||
"medium_term_goals": [
|
||||
"Achieve 95% debugging success rate",
|
||||
"Reduce average task time by 30%",
|
||||
"Implement predictive error prevention"
|
||||
],
|
||||
"long_term_vision": [
|
||||
"Autonomous error resolution",
|
||||
"Self-optimizing performance",
|
||||
"Continuous improvement without manual intervention"
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### Basic Analysis
|
||||
```bash
|
||||
/improve-plugin
|
||||
```
|
||||
|
||||
**Default Behavior**:
|
||||
- Analyzes last 30 days of experience data
|
||||
- Generates 3-5 high-priority improvement prompts
|
||||
- Stores results in unified improvements file
|
||||
- Provides summary in terminal
|
||||
- Creates detailed analysis report
|
||||
|
||||
### Custom Timeframe
|
||||
```bash
|
||||
# Analyze last 7 days
|
||||
/improve-plugin --days 7
|
||||
|
||||
# Analyze last 90 days
|
||||
/improve-plugin --days 90
|
||||
|
||||
# Analyze since specific date
|
||||
/improve-plugin --since 2025-09-01
|
||||
```
|
||||
|
||||
### Specific Analysis Focus
|
||||
```bash
|
||||
# Focus on debugging performance
|
||||
/improve-plugin --focus debugging
|
||||
|
||||
# Focus on quality improvements
|
||||
/improve-plugin --focus quality
|
||||
|
||||
# Focus on speed/efficiency
|
||||
/improve-plugin --focus efficiency
|
||||
|
||||
# Focus on user experience
|
||||
/improve-plugin --focus ux
|
||||
```
|
||||
|
||||
### Output Options
|
||||
```bash
|
||||
# Detailed JSON output
|
||||
/improve-plugin --verbose
|
||||
|
||||
# Summary only
|
||||
/improve-plugin --summary
|
||||
|
||||
# Save custom report location
|
||||
/improve-plugin --output ./custom-improvements.json
|
||||
|
||||
# Generate actionable checklist
|
||||
/improve-plugin --checklist
|
||||
```
|
||||
|
||||
## Command Delegation
|
||||
|
||||
The `/improve-plugin` command delegates to the **learning-engine** agent for comprehensive pattern analysis:
|
||||
|
||||
### Learning-Engine Agent Responsibilities
|
||||
|
||||
1. **Experience Data Aggregation**
|
||||
- Collect pattern database entries
|
||||
- Analyze performance metrics
|
||||
- Review command usage statistics
|
||||
- Identify success/failure patterns
|
||||
|
||||
2. **Pattern Recognition**
|
||||
- Detect recurring successful approaches
|
||||
- Identify common failure modes
|
||||
- Analyze learning progression
|
||||
- Recognize optimization opportunities
|
||||
|
||||
3. **Improvement Generation**
|
||||
- Create structured improvement prompts
|
||||
- Prioritize by impact and feasibility
|
||||
- Provide evidence-based recommendations
|
||||
- Generate actionable next steps
|
||||
|
||||
4. **Learning Integration**
|
||||
- Store analysis results in unified format
|
||||
- Update effectiveness metrics
|
||||
- Identify new patterns for future learning
|
||||
- Track improvement implementation success
|
||||
|
||||
## Skills Utilized
|
||||
|
||||
### pattern-learning
|
||||
- Recognize recurring successful patterns
|
||||
- Identify knowledge transfer opportunities
|
||||
- Analyze learning curve effectiveness
|
||||
|
||||
### code-analysis
|
||||
- Analyze code quality improvement patterns
|
||||
- Identify common code issues and their solutions
|
||||
- Track refactoring effectiveness
|
||||
|
||||
### quality-standards
|
||||
- Analyze quality score trends
|
||||
- Identify quality improvement opportunities
|
||||
- Track standards compliance patterns
|
||||
|
||||
### validation-standards
|
||||
- Analyze error prevention effectiveness
|
||||
- Identify validation pattern improvements
|
||||
- Track proactive error detection
|
||||
|
||||
## Analysis Output
|
||||
|
||||
### Terminal Summary
|
||||
|
||||
```
|
||||
🔍 PLUGIN IMPROVEMENT ANALYSIS COMPLETE
|
||||
Timeframe: Last 30 days
|
||||
Data Analyzed: 47 patterns, 89 command usages, 12 performance records
|
||||
|
||||
📊 KEY INSIGHTS:
|
||||
* Average Quality Score: 88.7/100 (+3.2 vs previous period)
|
||||
* Task Success Rate: 91% (+4% improvement)
|
||||
* Average Resolution Time: 6.8 minutes (-18% improvement)
|
||||
* Learning Velocity: Accelerating 🚀
|
||||
|
||||
🎯 TOP IMPROVEMENT OPPORTUNITIES:
|
||||
1. Debugging Performance Optimization (High Priority)
|
||||
- Current: 87% success rate, 8.2 min avg time
|
||||
- Target: 95% success rate, <5 min avg time
|
||||
|
||||
2. Cross-Project Pattern Transfer (Medium Priority)
|
||||
- Currently 12% transfer efficiency
|
||||
- Target: 35% transfer efficiency
|
||||
|
||||
3. Error Prediction System (Medium Priority)
|
||||
- Could prevent 23% of current failures
|
||||
|
||||
💾 IMPROVEMENTS STORED:
|
||||
File: ./improvements/unified-improvements.json
|
||||
Prompts Generated: 5
|
||||
Priority: High (2), Medium (2), Low (1)
|
||||
|
||||
📈 LEARNING TRENDS:
|
||||
Quality Score: +0.8 points/week
|
||||
Speed Improvement: -12% time/week
|
||||
Pattern Utilization: +5%/week
|
||||
|
||||
⏱ Analysis completed in 2.3 seconds
|
||||
```
|
||||
|
||||
### Detailed Report File
|
||||
|
||||
**Location**: `.claude/data/reports/plugin-improvement-YYYY-MM-DD.md`
|
||||
|
||||
**Contents**:
|
||||
- Complete analysis methodology
|
||||
- Detailed pattern recognition results
|
||||
- Comprehensive improvement prompts
|
||||
- Usage statistics and trends
|
||||
- Learning progression analysis
|
||||
- Actionable implementation checklist
|
||||
|
||||
## Integration with Plugin Development
|
||||
|
||||
### Continuous Improvement Loop
|
||||
|
||||
1. **User Interaction** -> Plugin executes tasks
|
||||
2. **Pattern Storage** -> Learning patterns captured
|
||||
3. **Experience Analysis** -> `/improve-plugin` generates insights
|
||||
4. **Improvement Implementation** -> Developers apply suggested improvements
|
||||
5. **Performance Monitoring** -> Dashboard tracks impact
|
||||
6. **Repeat** -> Continuous cycle of improvement
|
||||
|
||||
### Claude Code Integration
|
||||
|
||||
The unified improvements JSON file can be consumed by Claude Code to:
|
||||
- Automatically suggest plugin improvements
|
||||
- Prioritize development tasks based on user experience data
|
||||
- Track the impact of implemented improvements
|
||||
- Generate new feature ideas from usage patterns
|
||||
|
||||
### Example Improvement Implementation
|
||||
|
||||
```javascript
|
||||
// Claude Code could read improvements.json and suggest:
|
||||
// "Based on user experience analysis, implement debugging pattern database
|
||||
// to reduce resolution time from 8.2 to <5 minutes"
|
||||
```
|
||||
|
||||
## Data Sources Analyzed
|
||||
|
||||
### Pattern Database (`.claude-patterns/patterns.json`)
|
||||
- Task execution patterns and outcomes
|
||||
- Skill and agent effectiveness
|
||||
- Quality score trends
|
||||
- Learning progression data
|
||||
|
||||
### Performance Records (`.claude-patterns/enhanced_patterns.json`)
|
||||
- Debugging performance metrics
|
||||
- Quality improvement scores
|
||||
- Time efficiency measurements
|
||||
- Success rates by task type
|
||||
|
||||
### Command Usage Logs
|
||||
- Command frequency and popularity
|
||||
- Success rates by command
|
||||
- Common usage patterns
|
||||
- Feature utilization metrics
|
||||
|
||||
### Error Logs
|
||||
- Common failure modes
|
||||
- Error context analysis
|
||||
- Recovery patterns
|
||||
- Prevention opportunities
|
||||
|
||||
### Dashboard Analytics
|
||||
- Real-time performance monitoring
|
||||
- User interaction patterns
|
||||
- Feature usage statistics
|
||||
- System health trends
|
||||
|
||||
## Improvement Prompt Categories
|
||||
|
||||
### 1. Performance Optimization
|
||||
- Faster task execution
|
||||
- Better resource utilization
|
||||
- Improved response times
|
||||
- Enhanced efficiency metrics
|
||||
|
||||
### 2. Quality Enhancement
|
||||
- Higher success rates
|
||||
- Better error prevention
|
||||
- Improved accuracy
|
||||
- Enhanced reliability
|
||||
|
||||
### 3. User Experience
|
||||
- Simplified workflows
|
||||
- Better feedback systems
|
||||
- More intuitive interfaces
|
||||
- Enhanced discoverability
|
||||
|
||||
### 4. Feature Enhancement
|
||||
- New functionality suggestions
|
||||
- Expanded capabilities
|
||||
- Better integration
|
||||
- Enhanced automation
|
||||
|
||||
### 5. Error Prevention
|
||||
- Proactive error detection
|
||||
- Better validation systems
|
||||
- Improved error messages
|
||||
- Enhanced recovery mechanisms
|
||||
|
||||
### 6. Learning Enhancement
|
||||
- Better pattern recognition
|
||||
- Improved knowledge transfer
|
||||
- Enhanced adaptation capabilities
|
||||
- Smarter decision making
|
||||
|
||||
## Quality Assurance
|
||||
|
||||
### Validation Criteria
|
||||
- **Data Completeness**: All relevant data sources analyzed
|
||||
- **Pattern Accuracy**: Recognized patterns validated against actual outcomes
|
||||
- **Prompt Quality**: Improvement prompts are actionable and evidence-based
|
||||
- **Priority Accuracy**: High-impact improvements prioritized correctly
|
||||
- **Format Consistency**: JSON structure follows unified schema
|
||||
|
||||
### Continuous Learning
|
||||
- Analysis effectiveness is tracked and improved
|
||||
- Prompt accuracy is measured against implementation results
|
||||
- Pattern recognition is refined based on outcomes
|
||||
- Learning algorithms are optimized continuously
|
||||
|
||||
## Examples of Generated Prompts
|
||||
|
||||
### Example 1: Debugging Performance
|
||||
```json
|
||||
{
|
||||
"id": "debugging_pattern_database",
|
||||
"priority": "high",
|
||||
"category": "performance",
|
||||
"prompt": "Implement a comprehensive debugging pattern database that stores successful debugging approaches and automatically suggests solutions for similar issues. Based on analysis of 47 debugging tasks, this could reduce average resolution time from 8.2 minutes to under 5 minutes and improve success rate from 87% to 95%.",
|
||||
"evidence": {
|
||||
"sample_size": 47,
|
||||
"current_performance": "8.2 min avg, 87% success",
|
||||
"target_performance": "<5 min avg, 95% success",
|
||||
"confidence": "high"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Example 2: Cross-Project Learning
|
||||
```json
|
||||
{
|
||||
"id": "cross_project_pattern_transfer",
|
||||
"priority": "medium",
|
||||
"category": "learning",
|
||||
"prompt": "Enhance the pattern learning system to transfer knowledge between different projects automatically. Current transfer efficiency is only 12%, but analysis shows potential for 35% efficiency by implementing context-aware pattern matching and project-agnostic skill identification.",
|
||||
"evidence": {
|
||||
"projects_analyzed": 8,
|
||||
"current_efficiency": "12%",
|
||||
"target_efficiency": "35%",
|
||||
"implementation_complexity": "medium"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Example 3: User Experience Enhancement
|
||||
```json
|
||||
{
|
||||
"id": "predictive_error_prevention",
|
||||
"priority": "medium",
|
||||
"category": "ux",
|
||||
"prompt": "Implement a predictive error prevention system that identifies potential issues before they occur based on pattern analysis. This could prevent 23% of current failures and improve overall user satisfaction by providing proactive guidance.",
|
||||
"evidence": {
|
||||
"failure_patterns_analyzed": 156,
|
||||
"preventable_failures": "23%",
|
||||
"implementation_approach": "pattern-based prediction",
|
||||
"expected_impact": "high"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Benefits
|
||||
|
||||
### For Users
|
||||
- Continuous improvement based on actual usage patterns
|
||||
- Proactive identification and resolution of pain points
|
||||
- Enhanced performance and reliability over time
|
||||
- Personalized optimization based on individual usage
|
||||
|
||||
### For Developers
|
||||
- Data-driven development priorities
|
||||
- Clear evidence-based improvement suggestions
|
||||
- Understanding of real-world usage patterns
|
||||
- Measurable impact of improvements
|
||||
|
||||
### For the Plugin
|
||||
- Autonomous self-improvement capabilities
|
||||
- Adaptive performance optimization
|
||||
- Enhanced learning and pattern recognition
|
||||
- Continuous evolution without manual intervention
|
||||
|
||||
## Implementation Notes
|
||||
|
||||
### Requirements
|
||||
- Existing pattern database with sufficient history (minimum 10 tasks)
|
||||
- Performance tracking system
|
||||
- Command usage logging
|
||||
- Access to learning patterns and metrics
|
||||
|
||||
### Limitations
|
||||
- Requires minimum data volume for meaningful analysis
|
||||
- Improvement prompts are suggestions, not guaranteed solutions
|
||||
- Pattern recognition accuracy depends on data quality
|
||||
- Implementation of improvements requires developer action
|
||||
|
||||
### Future Enhancements
|
||||
- Real-time experience analysis
|
||||
- Automatic improvement implementation
|
||||
- Cross-plugin pattern sharing
|
||||
- AI-driven improvement prioritization
|
||||
|
||||
---
|
||||
|
||||
This command represents a key innovation in autonomous plugin development, creating a continuous feedback loop where user experiences directly drive plugin evolution and improvement.
|
||||
186
commands/workspace/organize.md
Normal file
186
commands/workspace/organize.md
Normal file
@@ -0,0 +1,186 @@
|
||||
---
|
||||
name: workspace:organize
|
||||
description: Automatically organize workspace files, consolidate reports, and validate links
|
||||
|
||||
delegates-to: autonomous-agent:orchestrator
|
||||
|
||||
# Command: `/workspace:organize`
|
||||
|
||||
Automatically organizes your workspace by moving files to appropriate directories, consolidating scattered reports, and fixing broken links. Improves project hygiene and maintains professional structure.
|
||||
|
||||
## Purpose
|
||||
|
||||
- Move misplaced files to their proper directories
|
||||
- Consolidate scattered reports into organized structure
|
||||
- Validate and fix documentation links
|
||||
- Maintain clean workspace for better productivity
|
||||
- Track workspace health over time
|
||||
|
||||
## What It Does
|
||||
|
||||
### 1. **Report File Organization** (15-30 seconds)
|
||||
- Move `*.md` reports from root -> `data/reports/generated/`
|
||||
- Consolidate `.reports*` directories into single location
|
||||
- Archive reports older than 30 days to `data/reports/archive/`
|
||||
- Create/update `data/reports/README.md` index
|
||||
|
||||
### 2. **Python Utility Organization** (10-20 seconds)
|
||||
- Move standalone Python scripts from root to `lib/`
|
||||
- Validate scripts still function after move
|
||||
- Check for import dependencies that need updating
|
||||
- Create `lib/README.md` if missing
|
||||
|
||||
### 3. **Pattern Storage Consolidation** (10-15 seconds)
|
||||
- Migrate any `patterns/` directories to `.claude-patterns/`
|
||||
- Validate pattern JSON format consistency
|
||||
- Remove old pattern locations if empty
|
||||
- Ensure `.claude-patterns/.gitignore` exists
|
||||
|
||||
### 4. **Link Validation & Fixing** (20-40 seconds)
|
||||
- Scan all `.md` files for internal links
|
||||
- Identify broken links to moved files
|
||||
- Update relative paths to new locations
|
||||
- Generate link validation report
|
||||
|
||||
### 5. **Gitignore Management** (5-10 seconds)
|
||||
- Check for `.gitignore` entries for organized directories
|
||||
- Add entries for `.claude/`, `.claude-patterns/`, `data/reports/generated/`
|
||||
- Prompt if major changes should be gitignored
|
||||
|
||||
### 6. **Workspace Health Report** (5-10 seconds)
|
||||
- Calculate before/after workspace health score
|
||||
- Show files organized and links fixed
|
||||
- Provide recommendations for further improvement
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
# Basic workspace organization
|
||||
/organize-workspace
|
||||
|
||||
# Dry run to see what would be moved
|
||||
/organize-workspace --dry-run
|
||||
|
||||
# Include archive cleanup (remove reports > 90 days)
|
||||
/organize-workspace --cleanup
|
||||
|
||||
# Skip link validation for faster execution
|
||||
/organize-workspace --no-validate-links
|
||||
```
|
||||
|
||||
## Output
|
||||
|
||||
### Terminal Summary (concise)
|
||||
```
|
||||
Workspace Organization Complete
|
||||
+- Health Score: 78/100 -> 92/100 ✅ (+14)
|
||||
+- Files Organized: 7 files moved
|
||||
+- Links Fixed: 3 links updated
|
||||
+- Reports Archived: 2 files
|
||||
+- Duration: 1m 23s
|
||||
|
||||
📄 Detailed report: .claude/data/reports/organize-workspace-2025-01-15.md
|
||||
```
|
||||
|
||||
### Detailed Report (file)
|
||||
- Complete list of files moved with source/destination
|
||||
- All links that were updated
|
||||
- Any broken links that need manual attention
|
||||
- Workspace health scoring breakdown
|
||||
- Recommendations for maintaining organization
|
||||
|
||||
## Directory Structure After Organization
|
||||
|
||||
```
|
||||
project/
|
||||
+-- docs/
|
||||
| +-- data/reports/
|
||||
| +-- README.md # Report index
|
||||
| +-- generated/ # Auto-generated reports
|
||||
| +-- archive/ # Old reports (>30 days)
|
||||
+-- lib/ # Python utilities
|
||||
| +-- README.md # Utility documentation
|
||||
+-- .claude-patterns/ # Learning patterns
|
||||
+-- .claude/ # Claude Code data
|
||||
+-- [other project files]
|
||||
```
|
||||
|
||||
## Integration
|
||||
|
||||
The `/organize-workspace` command integrates with:
|
||||
|
||||
- **workspace-organizer agent**: Handles the actual file operations
|
||||
- **validation-standards skill**: Ensures links are properly validated
|
||||
- **orchestrator**: Suggests organization when workspace health < 70
|
||||
|
||||
## Safety Features
|
||||
|
||||
- **Dry Run Mode**: Preview changes before executing
|
||||
- **Backup Creation**: Creates `.claude/backup/` before major moves
|
||||
- **Selective Execution**: Can skip specific organization steps
|
||||
- **Rollback Support**: Can undo last organization if needed
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1: Basic Organization
|
||||
```bash
|
||||
User: /organize-workspace
|
||||
|
||||
System: Moved 3 reports to data/reports/generated/
|
||||
Fixed 2 broken links in README.md
|
||||
Health score improved: 65/100 -> 85/100
|
||||
```
|
||||
|
||||
### Example 2: With Cleanup
|
||||
```bash
|
||||
User: /organize-workspace --cleanup
|
||||
|
||||
System: Archived 5 old reports (>90 days)
|
||||
Consolidated 2 .reports directories
|
||||
Created data/reports/README.md index
|
||||
```
|
||||
|
||||
## When to Use
|
||||
|
||||
Run `/organize-workspace` when:
|
||||
- Root directory has many report files
|
||||
- Multiple `.reports*` directories exist
|
||||
- Documentation links are broken
|
||||
- Workspace health score is below 70
|
||||
- Before major releases or code reviews
|
||||
|
||||
## Automation
|
||||
|
||||
The orchestrator can automatically suggest `/organize-workspace` when:
|
||||
- Workspace health drops below 70/100
|
||||
- More than 5 report files in root directory
|
||||
- Broken links detected in documentation
|
||||
|
||||
## Notes
|
||||
|
||||
- Always creates backup before major file moves
|
||||
- Preserves file history and timestamps
|
||||
- Updates all internal documentation links
|
||||
- Respects existing `.gitignore` entries
|
||||
- Works with any project structure
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Run before releases**: Clean workspace for professional presentation
|
||||
2. **Check after analysis**: Analysis commands often generate reports
|
||||
3. **Regular maintenance**: Run monthly to prevent accumulation
|
||||
4. **Review changes**: Check the detailed report after organization
|
||||
5. **Update team**: Inform team members about new file locations
|
||||
|
||||
## Related Commands
|
||||
|
||||
- `/validate-patterns` - Validate pattern learning consistency
|
||||
- `/quality-check` - Run after organization to ensure quality
|
||||
- `/learn-patterns` - Initialize pattern learning system
|
||||
|
||||
## See Also
|
||||
|
||||
- [Workspace Organization Guide](../docs/guidelines/WORKSPACE_ORGANIZATION.md)
|
||||
- [Link Validation Standards](../skills/validation-standards/SKILL.md)
|
||||
- [Workspace-Organizer Agent](../agents/workspace-organizer.md)
|
||||
---
|
||||
556
commands/workspace/reports.md
Normal file
556
commands/workspace/reports.md
Normal file
@@ -0,0 +1,556 @@
|
||||
---
|
||||
name: workspace:reports
|
||||
description: Organize and consolidate scattered reports into clean directory structure
|
||||
delegates-to: autonomous-agent:orchestrator
|
||||
---
|
||||
|
||||
# Organize Reports Command
|
||||
|
||||
## Command: `/workspace:reports`
|
||||
|
||||
Automated report organization and management system that categorizes, archives, and optimizes all validation, quality, and analysis reports with intelligent cleanup and searchable storage.
|
||||
|
||||
## How It Works
|
||||
|
||||
1. **Report Discovery**: Scans repository for all report files and analyzes content
|
||||
2. **Intelligent Categorization**: Classifies reports by type, importance, and relevance
|
||||
3. **Organized Storage**: Moves reports to structured directory hierarchy
|
||||
4. **Automated Archival**: Archives old reports based on retention policies
|
||||
5. **Duplicate Management**: Identifies and merges duplicate or redundant reports
|
||||
6. **Search Indexing**: Creates searchable metadata index for all reports
|
||||
7. **Cleanup Optimization**: Removes obsolete files and optimizes storage
|
||||
|
||||
## Usage
|
||||
|
||||
### Basic Organization
|
||||
```bash
|
||||
# Organize all reports with default settings
|
||||
/workspace:reports
|
||||
|
||||
# Quick organization (current reports only)
|
||||
/organize-reports --quick
|
||||
|
||||
# Deep organization (includes archival and compression)
|
||||
/organize-reports --deep
|
||||
```
|
||||
|
||||
### Advanced Organization Options
|
||||
```bash
|
||||
# Custom organization with specific rules
|
||||
/organize-reports \
|
||||
--archive-policy 90days \
|
||||
--compress-old \
|
||||
--remove-duplicates \
|
||||
--create-index
|
||||
|
||||
# Organize specific report types
|
||||
/organize-reports --type validation
|
||||
/organize-reports --type quality,performance
|
||||
|
||||
# Organize by date range
|
||||
/organize-reports --date-range "2024-01-01..2024-01-31"
|
||||
/organize-reports --older-than 30days
|
||||
```
|
||||
|
||||
### Dry Run and Preview
|
||||
```bash
|
||||
# Preview organization without making changes
|
||||
/organize-reports --dry-run
|
||||
|
||||
# Show detailed analysis before organizing
|
||||
/organize-reports --analyze
|
||||
|
||||
# Interactive mode with confirmation prompts
|
||||
/organize-reports --interactive
|
||||
```
|
||||
|
||||
## Organization Structure
|
||||
|
||||
### Target Directory Structure
|
||||
```
|
||||
.data/reports/
|
||||
+-- current/ # Active reports (last 30 days)
|
||||
| +-- validation/ # Plugin validation reports
|
||||
| | +-- plugin-validation-2024-01-15.md
|
||||
| | +-- claude-plugin-validation-2024-01-14.md
|
||||
| | +-- installation-validation-2024-01-13.md
|
||||
| +-- quality/ # Quality assessment reports
|
||||
| | +-- code-quality-2024-01-15.md
|
||||
| | +-- standards-compliance-2024-01-14.md
|
||||
| | +-- best-practices-2024-01-13.md
|
||||
| +-- performance/ # Performance analysis reports
|
||||
| | +-- execution-time-analysis-2024-01-15.md
|
||||
| | +-- resource-usage-2024-01-14.md
|
||||
| +-- security/ # Security scan reports
|
||||
| | +-- vulnerability-scan-2024-01-15.md
|
||||
| | +-- dependency-security-2024-01-14.md
|
||||
| +-- testing/ # Test execution reports
|
||||
| | +-- test-coverage-2024-01-15.md
|
||||
| | +-- test-results-2024-01-14.md
|
||||
| +-- summary/ # Executive summary reports
|
||||
| +-- weekly-summary-2024-01-15.md
|
||||
| +-- monthly-report-2024-01-01.md
|
||||
+-- recent/ # Recent reports (30-90 days)
|
||||
| +-- 2024-01/ # Monthly organization
|
||||
| | +-- validation/
|
||||
| | +-- quality/
|
||||
| | +-- performance/
|
||||
| +-- 2023-12/
|
||||
+-- archive/ # Archived reports (90+ days)
|
||||
| +-- 2023/ # Yearly organization
|
||||
| | +-- Q1/ # Quarterly organization
|
||||
| | | +-- validation/
|
||||
| | | +-- quality/
|
||||
| | | +-- performance/
|
||||
| | +-- Q2/
|
||||
| | +-- Q3/
|
||||
| | +-- Q4/
|
||||
| +-- 2022/
|
||||
+-- templates/ # Report templates
|
||||
| +-- validation-template.md
|
||||
| +-- quality-template.md
|
||||
| +-- performance-template.md
|
||||
+-- metrics/ # Aggregated metrics and trends
|
||||
| +-- quality-trends.json
|
||||
| +-- performance-metrics.json
|
||||
| +-- validation-history.json
|
||||
+-- index/ # Search indices and metadata
|
||||
+-- reports-index.json
|
||||
+-- search-index.json
|
||||
+-- metadata-db.json
|
||||
```
|
||||
|
||||
## Command Line Options
|
||||
|
||||
### Organization Mode
|
||||
```bash
|
||||
--quick # Quick organization (current reports only)
|
||||
--deep # Deep organization (includes archival, compression)
|
||||
--analyze # Analyze reports without organizing
|
||||
--dry-run # Preview changes without executing
|
||||
--interactive # Interactive mode with confirmations
|
||||
```
|
||||
|
||||
### Report Selection
|
||||
```bash
|
||||
--type <types> # Specific report types to organize
|
||||
# Values: validation,quality,performance,security,
|
||||
# testing,documentation,summary
|
||||
# Default: all
|
||||
|
||||
--date-range <range> # Date range for reports (YYYY-MM-DD..YYYY-MM-DD)
|
||||
--older-than <period> # Reports older than period (e.g., 30days, 3months)
|
||||
--newer-than <period> # Reports newer than period
|
||||
--pattern <pattern> # File pattern matching (glob)
|
||||
```
|
||||
|
||||
### Archival Options
|
||||
```bash
|
||||
--archive-policy <policy> # Archival retention policy
|
||||
# Values: 30days, 60days, 90days, 6months, 1year
|
||||
# Default: 90days
|
||||
|
||||
--compress-old # Compress reports older than archival period
|
||||
--compress-level <level> # Compression level (1-9, default: 6)
|
||||
|
||||
--keep-critical # Keep critical reports indefinitely
|
||||
--keep-high-importance # Keep high importance reports longer
|
||||
```
|
||||
|
||||
### Cleanup Options
|
||||
```bash
|
||||
--remove-duplicates # Remove duplicate reports
|
||||
--merge-similar # Merge similar reports
|
||||
--remove-obsolete # Remove superseded reports
|
||||
--cleanup-temp # Clean temporary and intermediate files
|
||||
|
||||
--storage-limit <size> # Maximum storage usage (e.g., 500MB, 2GB)
|
||||
--free-space <size> # Target free space to maintain
|
||||
```
|
||||
|
||||
### Index and Search
|
||||
```bash
|
||||
--create-index # Create searchable index
|
||||
--update-index # Update existing index
|
||||
--rebuild-index # Rebuild index from scratch
|
||||
|
||||
--extract-metadata # Extract and store metadata
|
||||
--generate-thumbnails # Generate report thumbnails/summaries
|
||||
--create-summaries # Generate executive summaries
|
||||
```
|
||||
|
||||
### Output Control
|
||||
```bash
|
||||
--verbose # Detailed output logging
|
||||
--quiet # Minimal output
|
||||
--summary # Show organization summary only
|
||||
--report-file <file> # Save detailed report to file
|
||||
|
||||
--json-output # Output in JSON format
|
||||
--csv-output # Output in CSV format
|
||||
```
|
||||
|
||||
## Workflow Stages
|
||||
|
||||
### Stage 1: Report Discovery (10-30 seconds)
|
||||
|
||||
**Scans and identifies**:
|
||||
- All report files in repository
|
||||
- Report types based on content analysis
|
||||
- File metadata (size, dates, hashes)
|
||||
- Duplicate or similar reports
|
||||
|
||||
**Output**:
|
||||
```
|
||||
============================================================
|
||||
REPORT DISCOVERY
|
||||
============================================================
|
||||
|
||||
📁 Report Files Found: 18
|
||||
+- Root Directory: 3 files
|
||||
+- Subdirectories: 15 files
|
||||
+- Hidden Reports: 0 files
|
||||
|
||||
📊 Report Types Detected:
|
||||
+- Validation Reports: 6
|
||||
+- Quality Reports: 4
|
||||
+- Performance Reports: 3
|
||||
+- Plugin Reports: 2
|
||||
+- Security Reports: 1
|
||||
+- Summary Reports: 2
|
||||
|
||||
🔍 Analysis Results:
|
||||
+- Total Size: 2.4 MB
|
||||
+- Duplicate Files: 2
|
||||
+- Obsolete Reports: 1
|
||||
+- Critical Reports: 3
|
||||
+- High Importance: 7
|
||||
|
||||
⏱ Discovery completed in 23 seconds
|
||||
```
|
||||
|
||||
### Stage 2: Categorization and Analysis (30-60 seconds)
|
||||
|
||||
**Analyzes and categorizes**:
|
||||
- Report content and structure
|
||||
- Importance and relevance scoring
|
||||
- Date-based categorization
|
||||
- Cross-reference relationships
|
||||
|
||||
**Output**:
|
||||
```
|
||||
============================================================
|
||||
CATEGORIZATION ANALYSIS
|
||||
============================================================
|
||||
|
||||
📋 Classification Results:
|
||||
+- Current Reports (≤30 days): 8 files
|
||||
+- Recent Reports (30-90 days): 6 files
|
||||
+- Archive Candidates (>90 days): 4 files
|
||||
+- Template Files: 0 files
|
||||
|
||||
🎯 Importance Distribution:
|
||||
+- Critical Issues: 3 reports
|
||||
| +- Security vulnerabilities
|
||||
| +- Breaking validation failures
|
||||
| +- Critical quality issues
|
||||
+- High Priority: 7 reports
|
||||
+- Medium Priority: 5 reports
|
||||
+- Low Priority: 3 reports
|
||||
|
||||
🔗 Report Relationships:
|
||||
+- Related Report Groups: 4
|
||||
+- Duplicate Pairs: 2
|
||||
+- Sequential Reports: 3
|
||||
+- Cross-References: 12
|
||||
|
||||
📈 Quality Metrics:
|
||||
+- Average Report Score: 82/100
|
||||
+- Completeness Rate: 94%
|
||||
+- Consistency Score: 88%
|
||||
+- Actionability Index: 76%
|
||||
|
||||
⏱ Categorization completed in 47 seconds
|
||||
```
|
||||
|
||||
### Stage 3: Organization Execution (1-3 minutes)
|
||||
|
||||
**Executes organization**:
|
||||
- Creates directory structure
|
||||
- Moves files to appropriate locations
|
||||
- Updates file names and metadata
|
||||
- Creates cross-references and links
|
||||
|
||||
**Output**:
|
||||
```
|
||||
============================================================
|
||||
ORGANIZATION EXECUTION
|
||||
============================================================
|
||||
|
||||
📂 Directory Structure Created:
|
||||
+- .data/reports/current/validation/ [PASS]
|
||||
+- .data/reports/current/quality/ [PASS]
|
||||
+- .data/reports/current/performance/ [PASS]
|
||||
+- .data/reports/recent/2024-01/ [PASS]
|
||||
+- .data/reports/archive/2023/Q4/ [PASS]
|
||||
+- .data/reports/metrics/ [PASS]
|
||||
|
||||
📁 Files Organized:
|
||||
+- Current Reports: 8 files moved
|
||||
+- Recent Reports: 6 files moved
|
||||
+- Archived Reports: 4 files moved
|
||||
+- Duplicates Removed: 2 files
|
||||
+- Obsolete Reports: 1 file removed
|
||||
|
||||
🏷️ File Naming Applied:
|
||||
+- Standardized format: {type}-{date}-{id}.md
|
||||
+- Consistent date format: YYYY-MM-DD
|
||||
+- Unique identifiers added: 12 files
|
||||
+- Metadata embedded: 18 files
|
||||
|
||||
🔗 Cross-References Created:
|
||||
+- Related reports linked: 12 links
|
||||
+- Sequential reports grouped: 3 groups
|
||||
+- Summary reports updated: 2 summaries
|
||||
+- Index entries created: 18 entries
|
||||
|
||||
📊 Storage Optimization:
|
||||
+- Space Saved: 156 KB (6.5% reduction)
|
||||
+- Compression Applied: 4 files
|
||||
+- Duplicates Removed: 320 KB
|
||||
+- Index Size: 45 KB
|
||||
|
||||
🎯 Organization Status: SUCCESS
|
||||
⏱ Organization completed in 2.1 minutes
|
||||
```
|
||||
|
||||
### Stage 4: Index Creation and Search (30-60 seconds)
|
||||
|
||||
**Creates search infrastructure**:
|
||||
- Full-text search index
|
||||
- Metadata database
|
||||
- Cross-reference map
|
||||
- Trend analysis data
|
||||
|
||||
**Output**:
|
||||
```
|
||||
============================================================
|
||||
SEARCH INDEX CREATION
|
||||
============================================================
|
||||
|
||||
🔍 Search Index Built:
|
||||
+- Full-Text Index: 18 documents indexed
|
||||
+- Metadata Database: 18 records
|
||||
+- Cross-Reference Map: 32 relationships
|
||||
+- Trend Data: 6 months of history
|
||||
|
||||
📊 Index Statistics:
|
||||
+- Total Terms: 3,247 unique terms
|
||||
+- Document Count: 18 reports
|
||||
+- Average Document Size: 15.2 KB
|
||||
+- Index Size: 127 KB
|
||||
+- Search Speed: <50ms average
|
||||
|
||||
🎯 Search Capabilities:
|
||||
+- Content Search: Full-text search across all reports
|
||||
+- Metadata Search: Search by type, date, importance
|
||||
+- Trend Analysis: Track metrics over time
|
||||
+- Comparative Analysis: Compare similar reports
|
||||
+- Custom Queries: Advanced search with filters
|
||||
|
||||
📈 Analytics Data Generated:
|
||||
+- Quality Trends: Monthly quality score progression
|
||||
+- Issue Patterns: Common issues and frequencies
|
||||
+- Resolution Times: Average time to address issues
|
||||
+- Improvement Metrics: Progress tracking over time
|
||||
|
||||
🔗 Integration Ready:
|
||||
+- CLI Search Interface: Available
|
||||
+- Web Dashboard: Optional
|
||||
+- API Access: RESTful API available
|
||||
+- Export Formats: JSON, CSV, PDF
|
||||
|
||||
🎯 Index Creation: SUCCESS
|
||||
⏱ Index creation completed in 54 seconds
|
||||
```
|
||||
|
||||
## Search and Retrieval
|
||||
|
||||
### Built-in Search Commands
|
||||
```bash
|
||||
# Search by content
|
||||
search-reports "validation failed" --type validation
|
||||
|
||||
# Search by metadata
|
||||
search-reports --importance critical --date-range "2024-01-01..2024-01-31"
|
||||
|
||||
# Trend analysis
|
||||
analyze-trends --metric quality_score --period monthly
|
||||
|
||||
# Generate summaries
|
||||
generate-summary --type validation --period "last_30_days"
|
||||
|
||||
# Compare reports
|
||||
compare-reports --type validation --date-range "2023-12..2024-01"
|
||||
```
|
||||
|
||||
### Search Query Examples
|
||||
```bash
|
||||
# Find critical security issues
|
||||
search-reports "security vulnerability" --importance critical --type security
|
||||
|
||||
# Track quality improvements
|
||||
search-reports --type quality --metric score --trend improving
|
||||
|
||||
# Find all validation reports from January
|
||||
search-reports --type validation --date 2024-01
|
||||
|
||||
# Generate performance summary
|
||||
generate-summary --type performance --format markdown --output performance-summary.md
|
||||
```
|
||||
|
||||
## Integration with Other Commands
|
||||
|
||||
### With Validation Commands
|
||||
```bash
|
||||
# Run validation then organize results
|
||||
/validate-fullstack
|
||||
/organize-reports --type validation --quick
|
||||
```
|
||||
|
||||
### With Quality Commands
|
||||
```bash
|
||||
# Quality check with report organization
|
||||
/quality-check
|
||||
/organize-reports --type quality --create-index
|
||||
```
|
||||
|
||||
### With Learning Commands
|
||||
```bash
|
||||
# Analyze patterns and organize findings
|
||||
/auto-analyze
|
||||
/organize-reports --deep --extract-metadata
|
||||
```
|
||||
|
||||
## Retention Policies
|
||||
|
||||
### Default Retention Rules
|
||||
```yaml
|
||||
retention_policies:
|
||||
current_reports:
|
||||
duration: 30 days
|
||||
compression: false
|
||||
backup: true
|
||||
|
||||
recent_reports:
|
||||
duration: 90 days
|
||||
compression: true
|
||||
backup: true
|
||||
|
||||
archived_reports:
|
||||
duration: 1 year
|
||||
compression: true
|
||||
backup: true
|
||||
|
||||
critical_reports:
|
||||
duration: permanent
|
||||
compression: false
|
||||
backup: true
|
||||
multiple_copies: true
|
||||
```
|
||||
|
||||
### Custom Retention Rules
|
||||
```bash
|
||||
# Set custom retention policy
|
||||
/organize-reports \
|
||||
--archive-policy 6months \
|
||||
--keep-critical \
|
||||
--compress-old \
|
||||
--storage-limit 1GB
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Regular Organization
|
||||
- **Daily**: Quick organization of new reports
|
||||
- **Weekly**: Deep organization with archival
|
||||
- **Monthly**: Index rebuilding and optimization
|
||||
- **Quarterly**: Complete cleanup and retention review
|
||||
|
||||
### Storage Management
|
||||
- Monitor storage usage regularly
|
||||
- Set appropriate retention policies
|
||||
- Compress old reports to save space
|
||||
- Maintain backups of critical reports
|
||||
|
||||
### Search Optimization
|
||||
- Update index regularly
|
||||
- Use descriptive file names
|
||||
- Add relevant metadata and tags
|
||||
- Create executive summaries for quick reference
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
**Insufficient Permissions**:
|
||||
```bash
|
||||
# Check permissions
|
||||
ls -la .data/reports/
|
||||
# Fix permissions
|
||||
chmod -R 755 .data/reports/
|
||||
```
|
||||
|
||||
**Storage Space Issues**:
|
||||
```bash
|
||||
# Check disk usage
|
||||
df -h
|
||||
# Free up space
|
||||
/organize-reports --compress-old --archive-policy 30days
|
||||
```
|
||||
|
||||
**Search Index Corruption**:
|
||||
```bash
|
||||
# Rebuild index
|
||||
/organize-reports --rebuild-index
|
||||
```
|
||||
|
||||
### Recovery Procedures
|
||||
|
||||
**Lost Reports**:
|
||||
```bash
|
||||
# Check for moved files
|
||||
find . -name "*validation*" -type f
|
||||
# Restore from backup if available
|
||||
```
|
||||
|
||||
**Damaged Index**:
|
||||
```bash
|
||||
# Remove corrupted index
|
||||
rm -f .data/reports/index/*.json
|
||||
# Rebuild from scratch
|
||||
/organize-reports --rebuild-index --deep
|
||||
```
|
||||
|
||||
## Integration with Learning System
|
||||
|
||||
The Report Organizer learns from organization patterns to improve future operations:
|
||||
|
||||
**Pattern Learning**:
|
||||
- Optimal categorization rules for different report types
|
||||
- User preferences for report organization and access
|
||||
- Common report patterns and relationships
|
||||
- Storage optimization strategies based on usage
|
||||
|
||||
**Continuous Improvement**:
|
||||
- Improved duplicate detection algorithms
|
||||
- Better relevance scoring for reports
|
||||
- Enhanced search result ranking
|
||||
- Optimized retention policies
|
||||
|
||||
---
|
||||
|
||||
**Version**: 1.0.0
|
||||
**Platform**: Cross-platform (Windows, Linux, Mac)
|
||||
**Dependencies**: Standard file system tools
|
||||
**Integration**: Works with all validation and quality reporting commands
|
||||
124
commands/workspace/update-about.md
Normal file
124
commands/workspace/update-about.md
Normal file
@@ -0,0 +1,124 @@
|
||||
---
|
||||
name: workspace:update-about
|
||||
description: Update GitHub About section with SEO-optimized description, topics, and links
|
||||
delegates-to: autonomous-agent:documentation-generator
|
||||
---
|
||||
|
||||
# Workspace Update-About Command
|
||||
|
||||
## Command: `/workspace:update-about`
|
||||
|
||||
**GitHub About section optimization** - Updates the repository's About section (description, topics, website) on GitHub with current project information and optimizes for search and discovery.
|
||||
|
||||
**🏷️ About Section Management:**
|
||||
- **Description Update**: Concise, accurate project description
|
||||
- **Topic Optimization**: Relevant tags for discoverability
|
||||
- **Website Link**: Updates project website if available
|
||||
- **SEO Optimization**: Optimizes for GitHub search
|
||||
- **Keyword Strategy**: Uses effective keywords
|
||||
- **Consistency**: Matches README and documentation
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
# Basic update (analyzes and updates)
|
||||
/workspace:update-about
|
||||
|
||||
# With custom description
|
||||
/workspace:update-about --description "AI-powered autonomous development plugin for Claude Code"
|
||||
|
||||
# Add/update topics
|
||||
/workspace:update-about --add-topics "ai,automation,claude,agents"
|
||||
|
||||
# SEO focus
|
||||
/workspace:update-about --seo-optimize
|
||||
|
||||
# Complete refresh
|
||||
/workspace:update-about --refresh-all
|
||||
```
|
||||
|
||||
## How It Works
|
||||
|
||||
1. **Current State Analysis**
|
||||
- Reads current About section via GitHub API
|
||||
- Analyzes current description and topics
|
||||
- Reviews project for accurate information
|
||||
|
||||
2. **Content Generation**
|
||||
- Generates concise description (max 350 chars)
|
||||
- Identifies relevant topics/tags
|
||||
- Optimizes for GitHub search
|
||||
- Ensures accuracy and clarity
|
||||
|
||||
3. **SEO Optimization**
|
||||
- Includes key searchable terms
|
||||
- Uses popular relevant topics
|
||||
- Balances specificity and discoverability
|
||||
- Follows GitHub best practices
|
||||
|
||||
4. **Update Execution**
|
||||
- Updates via GitHub API (requires token)
|
||||
- Validates changes
|
||||
- Preserves manual customizations if requested
|
||||
|
||||
## Output Format
|
||||
|
||||
```
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
🏷️ ABOUT SECTION UPDATED
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
|
||||
Description (Updated):
|
||||
"Autonomous AI agents for Claude Code with pattern learning,
|
||||
quality control, and full-stack validation. Zero-config,
|
||||
intelligent development automation."
|
||||
|
||||
Topics (Added 3):
|
||||
artificial-intelligence, automation, code-quality,
|
||||
pattern-learning, autonomous-agents, claude-code
|
||||
|
||||
SEO Score: 92/100
|
||||
+- Keywords: 8 high-value terms [PASS]
|
||||
+- Topic relevance: 95% [PASS]
|
||||
+- Discoverability: High [PASS]
|
||||
|
||||
[PASS] Updated on GitHub successfully
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
```
|
||||
|
||||
## Requirements
|
||||
|
||||
- GitHub personal access token with repo permissions
|
||||
- Set in environment variable: `GITHUB_TOKEN`
|
||||
- Repository must be on GitHub (GitLab support coming)
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Description Guidelines
|
||||
- Keep under 350 characters
|
||||
- Lead with main benefit/purpose
|
||||
- Include key features/differentiators
|
||||
- Use searchable keywords naturally
|
||||
- Avoid jargon unless necessary
|
||||
|
||||
### Topic Selection
|
||||
- Use 5-10 relevant topics
|
||||
- Mix general and specific terms
|
||||
- Include language/framework tags
|
||||
- Add domain-specific terms
|
||||
- Check GitHub's suggested topics
|
||||
|
||||
### SEO Optimization
|
||||
- Include primary keywords in description
|
||||
- Use popular, relevant topics
|
||||
- Match common search terms
|
||||
- Balance specificity and breadth
|
||||
- Monitor GitHub search results
|
||||
|
||||
---
|
||||
|
||||
**Version**: 1.0.0
|
||||
**Delegates-to**: documentation-generator agent
|
||||
**Requires**: GitHub API access (GITHUB_TOKEN)
|
||||
**Platform**: GitHub (GitLab support planned)
|
||||
**SEO**: Optimized for GitHub discovery
|
||||
111
commands/workspace/update-readme.md
Normal file
111
commands/workspace/update-readme.md
Normal file
@@ -0,0 +1,111 @@
|
||||
---
|
||||
name: workspace:update-readme
|
||||
description: Smart README update that learns your style and reflects current project state
|
||||
delegates-to: autonomous-agent:documentation-generator
|
||||
---
|
||||
|
||||
# Workspace Update-README Command
|
||||
|
||||
## Command: `/workspace:update-readme`
|
||||
|
||||
**Intelligent README maintenance** - Analyzes current README to understand its style, structure, and content approach, then intelligently updates it based on project changes while preserving the established voice and organization.
|
||||
|
||||
**📝 Smart README Updates:**
|
||||
- **Style Learning**: Understands current writing style and tone
|
||||
- **Structure Preservation**: Maintains existing section organization
|
||||
- **Content Synchronization**: Updates content to match current project state
|
||||
- **User Feedback Integration**: Incorporates user suggestions
|
||||
- **SEO Optimization**: Optimizes for GitHub search and discovery
|
||||
- **Quality Maintenance**: Ensures clarity and completeness
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
# Basic update (preserve style and structure)
|
||||
/workspace:update-readme
|
||||
|
||||
# With user suggestions
|
||||
/workspace:update-readme --suggestions "add installation video, improve examples"
|
||||
|
||||
# Change structure
|
||||
/workspace:update-readme --restructure "move installation first, add troubleshooting section"
|
||||
|
||||
# Update specific sections only
|
||||
/workspace:update-readme --sections "features,usage,examples"
|
||||
|
||||
# Complete rewrite (keep data, new style)
|
||||
/workspace:update-readme --rewrite --style "concise and technical"
|
||||
```
|
||||
|
||||
## How It Works
|
||||
|
||||
1. **Current README Analysis**
|
||||
- Analyzes existing style (formal, casual, technical, etc.)
|
||||
- Maps current structure and section organization
|
||||
- Identifies content patterns and conventions
|
||||
- Notes tone, voice, and audience level
|
||||
|
||||
2. **Project State Analysis**
|
||||
- Scans project for new features
|
||||
- Identifies changed functionality
|
||||
- Checks for outdated information
|
||||
- Reviews code comments and docstrings
|
||||
|
||||
3. **Update Strategy**
|
||||
- Plans sections to update
|
||||
- Determines what to add/remove/modify
|
||||
- Preserves user-provided style choices
|
||||
- Integrates user suggestions
|
||||
|
||||
4. **Implementation**
|
||||
- Updates content while maintaining style
|
||||
- Preserves formatting and structure
|
||||
- Adds new sections if needed
|
||||
- Validates links and examples
|
||||
|
||||
5. **Quality Check**
|
||||
- Verifies all links work
|
||||
- Tests code examples
|
||||
- Checks formatting
|
||||
- Validates completeness
|
||||
|
||||
## Output Format
|
||||
|
||||
```
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
📝 README UPDATE COMPLETE
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
|
||||
Style Preserved: Professional with examples
|
||||
Structure: Maintained (8 sections)
|
||||
|
||||
Changes Made:
|
||||
* Updated features list (+3 new features)
|
||||
* Refreshed usage examples
|
||||
* Added 2 new troubleshooting items
|
||||
* Updated installation instructions
|
||||
|
||||
Quality: 94/100
|
||||
+- All links verified [PASS]
|
||||
+- Code examples tested [PASS]
|
||||
+- Formatting consistent [PASS]
|
||||
|
||||
📄 Updated: README.md
|
||||
⏱ Completed in 45 seconds
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
```
|
||||
|
||||
## Integration with Learning
|
||||
|
||||
Learns README patterns:
|
||||
- Effective structures for project types
|
||||
- Successful writing styles
|
||||
- Common section organizations
|
||||
- User preferences
|
||||
|
||||
---
|
||||
|
||||
**Version**: 1.0.0
|
||||
**Delegates-to**: documentation-generator agent
|
||||
**Preserves**: Style, tone, structure (unless told otherwise)
|
||||
**Updates**: Content, examples, links, accuracy
|
||||
Reference in New Issue
Block a user