mirror of
https://github.com/mhattingpete/claude-skills-marketplace.git
synced 2026-11-18 18:04:26 +00:00
Feat/productivity skills plugin (#8)
* improve: enhance skill descriptions for better automatic activation Improved skill descriptions across both plugins to trigger more reliably when users make requests without specifying exact keywords or formats. ## Visual Documentation Plugin Skills All four skills improved to activate regardless of whether users specify HTML: - **flowchart-creator**: Removed "explicitly" and "in HTML format" restrictions Added triggers: "process flows" - **dashboard-creator**: Removed "explicitly" and "in HTML format" restrictions Added triggers: "monitoring interfaces" - **timeline-creator**: Removed "explicitly" and "in HTML format" restrictions Added triggers: "project plans" - **technical-doc-creator**: Removed "explicitly" and "in HTML format" restrictions Added triggers: "API references", "developer documentation" ## Engineering Workflow Plugin Skills All four skills enhanced with additional natural language triggers: - **feature-planning**: Removed "requires planning before implementation" (too restrictive) Added triggers: "create X feature", "I need X" - **test-fixing**: Added triggers: "run tests and fix failures", "tests aren't passing" - **git-pushing**: Added triggers: "push this", "push to github" - **review-implementing**: Added triggers: "fix review issues", "apply these suggestions" ## Testing Artifacts Added comprehensive test examples and sample outputs: - TEST_EXAMPLES.md with detailed test cases for each visual skill - Sample HTML outputs for flowchart and dashboard skills ## Impact Skills will now activate more reliably when users make natural requests without requiring exact phrasing or format specifications. This provides a better user experience and ensures skills are preferred over Claude's built-in knowledge. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * feat: add productivity-skills plugin with workflow optimization capabilities Add new productivity-skills plugin containing 4 skills for analyzing usage patterns, auditing code quality, bootstrapping projects, and generating documentation: - conversation-analyzer: Analyzes Claude Code usage patterns and suggests workflow improvements - Includes Python analysis script for comprehensive conversation history analysis - Identifies patterns, common mistakes, and automation opportunities - code-auditor: Comprehensive codebase analysis covering architecture, security, performance - project-bootstrapper: Sets up projects with best practices, tooling, and documentation - codebase-documenter: Generates comprehensive documentation for codebases Also includes: - CLAUDE.md: Development guidelines for building marketplace plugins and skills - Updated marketplace.json with productivity-skills plugin - Analysis scripts and tools bundled with conversation-analyzer skill - Updated .gitignore to exclude local analysis outputs Plugin follows marketplace conventions with proper structure (SKILL.md files, .claude-plugin/plugin.json, README.md, scripts/ and references/ directories). Based on analysis of 900+ Claude Code conversations to identify common workflow optimization needs and productivity patterns. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: enforce skills-first approach in CLAUDE.md guidelines Update development guidelines to make skills usage mandatory rather than optional: - Elevate "Skills first" to #1 priority in working guidelines - Create dedicated "Critical Working Guidelines" section - Add explicit rule: "ALWAYS use skills when available" - Specify concrete examples (git-pushing, feature-planning, test-fixing) - Emphasize: never implement manually when a skill exists This ensures consistent skill usage throughout the marketplace development and reinforces the skills-based workflow for all contributors. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * feat(git-pushing): add smart_commit.sh script for faster workflow Add automated script to speed up git-pushing skill execution: - Auto-stages all changes - Auto-generates conventional commit messages - Determines type (feat/fix/docs/test/chore/refactor) from file patterns - Extracts scope from changed files - Adds Claude Code footer automatically - Smart push handling (new vs existing branches) - Colored output for better UX - Shows PR link for GitHub repos Updated SKILL.md with: - Fast Path (recommended) - uses script for speed - Manual Path (fallback) - step-by-step commands Speed improvement: 1 command instead of 5+ separate bash calls. Script location: engineering-workflow-plugin/skills/git-pushing/scripts/smart_commit.sh 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * docs(CLAUDE.md): mandate skill-creator usage for new skills Add critical guideline requiring use of skill-creator skill when creating new skills: - Added explicit rule: "Use skill-creator for creating new skills" - Created "CRITICAL: When creating new skills" section - Emphasized that manual creation leads to missing files and incorrect structure - References issue where productivity-skills were created manually without proper structure This prevents future skills from being created with missing skill.json files, incorrect directory structure, or other structural issues. Lesson learned: productivity-skills plugin was created manually and lacks proper skill structure (missing skill.json files in skill directories). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * fix(productivity-skills): correct plugin structure to follow auto-discovery pattern Fix productivity-skills plugin to follow correct Claude Code plugin structure: Structural changes: - Move all skills into skills/ subdirectory (was at plugin root) - Remove skills array from plugin.json (skills are auto-discovered) - plugin.json now contains only metadata (name, version, description, author) Skills moved: - conversation-analyzer → skills/conversation-analyzer - code-auditor → skills/code-auditor - project-bootstrapper → skills/project-bootstrapper - codebase-documenter → skills/codebase-documenter CLAUDE.md updates: - Document that skills MUST be in skills/ subdirectory - Clarify that skills, agents, and commands are auto-discovered - Update plugin.json template to show metadata-only structure - Remove incorrect examples showing skills/agents arrays in plugin.json This follows the official Claude Code plugin structure where skills are automatically discovered from the skills/ directory rather than being listed in plugin.json. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * chore: Restructure of skills, add readme files --------- Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -22,6 +22,15 @@
|
||||
"author": {
|
||||
"name": "mhattingpete"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "productivity-skills",
|
||||
"source": "./productivity-skills-plugin",
|
||||
"description": "Productivity and workflow optimization skills for analyzing usage patterns, auditing code, bootstrapping projects, and generating documentation",
|
||||
"version": "1.0.0",
|
||||
"author": {
|
||||
"name": "mhattingpete"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -36,3 +36,10 @@ Temporary Items
|
||||
# Testing
|
||||
test_outputs/
|
||||
*.log
|
||||
|
||||
|
||||
# Local files
|
||||
ANALYSIS_SUMMARY.md
|
||||
IMPROVEMENT_GUIDE.md
|
||||
conversation_analysis.txt
|
||||
recommendations.txt
|
||||
|
||||
@@ -0,0 +1,798 @@
|
||||
# Claude Code Instructions for Skills Marketplace Development
|
||||
|
||||
**Repository:** claude-skills-marketplace
|
||||
**Purpose:** Development guidelines for creating high-quality Claude Code skills and plugins
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Repository Context
|
||||
|
||||
This is the **Claude Skills Marketplace** - a collection of reusable skills and plugins for Claude Code. When working in this repository, you are helping develop skills that will be used by many developers.
|
||||
|
||||
### Current Plugins
|
||||
|
||||
1. **engineering-workflow-skills** (v1.1.0)
|
||||
- feature-planning, test-fixing, git-pushing, review-implementing
|
||||
- plan-implementer agent
|
||||
|
||||
2. **visual-documentation-skills** (v1.0.0)
|
||||
- visual-html-creator for stunning HTML documentation
|
||||
|
||||
3. **productivity-skills** (v1.0.0)
|
||||
- conversation-analyzer, code-auditor, project-bootstrapper, codebase-documenter
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Plugin Structure Standards
|
||||
|
||||
### Required Directory Structure
|
||||
|
||||
```
|
||||
{plugin-name}-plugin/
|
||||
├── .claude-plugin/
|
||||
│ └── plugin.json # REQUIRED: Plugin metadata ONLY (no skills array)
|
||||
├── skills/ # Skills directory (auto-discovered)
|
||||
│ └── {skill-name}/
|
||||
│ ├── SKILL.md # REQUIRED: Skill specification
|
||||
│ ├── references/ # OPTIONAL: Reference materials (markdown)
|
||||
│ │ └── *.md # Additional context/guides
|
||||
│ └── scripts/ # OPTIONAL: Helper scripts
|
||||
│ └── *.py # Python scripts, shell scripts, etc.
|
||||
├── agents/ # OPTIONAL: Agents directory (auto-discovered)
|
||||
│ └── {agent-name}/
|
||||
│ └── AGENT.md # Agent specification
|
||||
├── commands/ # OPTIONAL: Commands directory (auto-discovered)
|
||||
│ └── {command-name}.md
|
||||
├── README.md # REQUIRED: Plugin documentation
|
||||
├── CHANGELOG.md # RECOMMENDED: Version history
|
||||
└── EXAMPLES.md # RECOMMENDED: Usage examples
|
||||
```
|
||||
|
||||
**CRITICAL: Skills are auto-discovered!**
|
||||
- Skills MUST be in `skills/` subdirectory at plugin root
|
||||
- Skills are automatically discovered - NO listing in plugin.json
|
||||
- plugin.json contains ONLY metadata (name, version, description, author)
|
||||
- Same applies to agents/ and commands/ - all auto-discovered
|
||||
|
||||
**Directory purposes:**
|
||||
- `skills/` - All skills (auto-discovered from SKILL.md files)
|
||||
- `agents/` - All agents (auto-discovered from AGENT.md files)
|
||||
- `commands/` - All commands (auto-discovered from .md files)
|
||||
- `references/` - Markdown documentation, guides, best practices
|
||||
- `scripts/` - Executable scripts (Python, shell, etc.) that skills can use
|
||||
|
||||
### Critical Files
|
||||
|
||||
#### 1. `.claude-plugin/plugin.json`
|
||||
|
||||
**Location matters!** Must be in `.claude-plugin/` subdirectory, not at root.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "example-skills",
|
||||
"version": "1.0.0",
|
||||
"description": "Clear, concise description of what the plugin provides",
|
||||
"author": {
|
||||
"name": "author-name"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Key points:**
|
||||
- **ONLY metadata** - name, version, description, author
|
||||
- **NO skills array** - skills are auto-discovered from skills/ directory
|
||||
- **NO agents array** - agents are auto-discovered from agents/ directory
|
||||
- **NO commands array** - commands are auto-discovered from commands/ directory
|
||||
- Keep it simple - just plugin metadata!
|
||||
|
||||
#### 2. `SKILL.md`
|
||||
|
||||
Every skill MUST have a SKILL.md file. This is the instruction set for Claude.
|
||||
|
||||
**Required sections:**
|
||||
|
||||
```markdown
|
||||
# {Skill Name}
|
||||
|
||||
## Purpose
|
||||
Clear statement of what this skill does and why it exists.
|
||||
|
||||
## When to Use
|
||||
List of scenarios where this skill is appropriate.
|
||||
|
||||
**Activation phrases:**
|
||||
- "phrase that triggers this skill"
|
||||
- "another trigger phrase"
|
||||
- "third example"
|
||||
|
||||
## What It Does
|
||||
Detailed explanation of the skill's workflow:
|
||||
1. First step
|
||||
2. Second step
|
||||
3. etc.
|
||||
|
||||
## Approach
|
||||
How the skill should approach the task, including:
|
||||
- Analysis strategy
|
||||
- Tool usage patterns
|
||||
- Decision-making criteria
|
||||
- Error handling
|
||||
|
||||
## Example Interaction
|
||||
```
|
||||
User: "example request"
|
||||
|
||||
Skill:
|
||||
1. Does X
|
||||
2. Asks Y
|
||||
3. Implements Z
|
||||
```
|
||||
|
||||
## Tools Used
|
||||
- **ToolName**: Why and when to use it
|
||||
- **AnotherTool**: Purpose
|
||||
|
||||
## Success Criteria
|
||||
How to know when the skill has succeeded:
|
||||
- Criterion 1
|
||||
- Criterion 2
|
||||
|
||||
## Integration
|
||||
How this skill works with other skills (if applicable).
|
||||
```
|
||||
|
||||
**Best practices for SKILL.md:**
|
||||
- Be specific about activation phrases
|
||||
- Include concrete examples
|
||||
- Explain the "why" not just the "what"
|
||||
- Mention tool usage patterns
|
||||
- Define success criteria clearly
|
||||
- Use realistic example interactions
|
||||
|
||||
#### 3. `README.md`
|
||||
|
||||
Plugin README should be user-facing documentation:
|
||||
|
||||
```markdown
|
||||
# {Plugin Name}
|
||||
|
||||
Brief description of what the plugin provides.
|
||||
|
||||
## Skills Included
|
||||
|
||||
### 1. Skill Name
|
||||
|
||||
**Purpose:** What it does
|
||||
|
||||
**Activates when you say:**
|
||||
- "trigger phrase"
|
||||
- "another phrase"
|
||||
|
||||
**What it does:**
|
||||
- Feature 1
|
||||
- Feature 2
|
||||
|
||||
**Example:**
|
||||
```
|
||||
User: "example"
|
||||
Claude: [does X, Y, Z]
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
Instructions for installing the plugin.
|
||||
|
||||
## Usage Tips
|
||||
|
||||
How to get the best results from these skills.
|
||||
|
||||
## Integration
|
||||
|
||||
How skills work together or with other plugins.
|
||||
|
||||
## Version
|
||||
|
||||
Current version number.
|
||||
|
||||
## Author
|
||||
|
||||
Author information.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎨 Skill Design Principles
|
||||
|
||||
### 1. Automatic Activation
|
||||
|
||||
Skills should activate based on **natural language intent**, not explicit invocation.
|
||||
|
||||
**Good activation triggers:**
|
||||
```
|
||||
"audit the code" → code-auditor
|
||||
"set up this project" → project-bootstrapper
|
||||
"fix the tests" → test-fixing
|
||||
```
|
||||
|
||||
**Bad (requiring explicit invocation):**
|
||||
```
|
||||
"/audit" → Too manual
|
||||
"run code-auditor" → Not natural
|
||||
```
|
||||
|
||||
### 2. Clear Scope
|
||||
|
||||
Each skill should have a **single, well-defined purpose**.
|
||||
|
||||
**Good (focused):**
|
||||
- `test-fixing`: Fix failing tests
|
||||
- `git-pushing`: Handle git operations
|
||||
- `code-auditor`: Audit code quality
|
||||
|
||||
**Bad (too broad):**
|
||||
- `do-everything`: Multiple unrelated functions
|
||||
- `developer-helper`: Vague purpose
|
||||
|
||||
### 3. Tool-Rich Implementation
|
||||
|
||||
Skills should leverage **all available tools** effectively:
|
||||
|
||||
- **Read**: File analysis
|
||||
- **Write/Edit**: Code changes
|
||||
- **Grep/Glob**: Pattern matching and file discovery
|
||||
- **Bash**: Execute commands, run tests
|
||||
- **Task (agents)**: Delegate complex sub-tasks
|
||||
- **AskUserQuestion**: Gather requirements
|
||||
|
||||
**Example from code-auditor:**
|
||||
```
|
||||
1. Use Explore agent for thorough codebase mapping
|
||||
2. Use Grep for pattern detection (security issues, TODOs)
|
||||
3. Use Read for detailed file analysis
|
||||
4. Use Bash to run linters/analyzers if available
|
||||
5. Synthesize findings into report
|
||||
```
|
||||
|
||||
### 4. User Interaction
|
||||
|
||||
When to ask vs. when to proceed:
|
||||
|
||||
**ASK when:**
|
||||
- Multiple valid approaches exist (technology choices, architectural decisions)
|
||||
- Requirements are ambiguous
|
||||
- User preference matters (depth of analysis, output format)
|
||||
- Potentially destructive operations
|
||||
|
||||
**PROCEED when:**
|
||||
- Best practice is clear
|
||||
- Request has sufficient context
|
||||
- Operation is safe and reversible
|
||||
- Asking would slow down unnecessarily
|
||||
|
||||
**Use AskUserQuestion for structured choices:**
|
||||
```
|
||||
Questions:
|
||||
- "Which testing framework?"
|
||||
Options: pytest, unittest, nose2
|
||||
- "Deployment target?"
|
||||
Options: Docker, AWS Lambda, Traditional server
|
||||
```
|
||||
|
||||
### 5. Comprehensive Documentation
|
||||
|
||||
Skills should be **self-documenting**:
|
||||
|
||||
- Explain what they're doing as they work
|
||||
- Provide file:line references for all findings
|
||||
- Summarize results clearly
|
||||
- Suggest next steps
|
||||
|
||||
**Good example:**
|
||||
```
|
||||
"I've analyzed the codebase and found 3 security issues:
|
||||
|
||||
1. SQL injection risk in database/query.py:45
|
||||
- Uses string concatenation for queries
|
||||
- Recommendation: Use parameterized queries
|
||||
|
||||
2. Hardcoded credentials in config/settings.py:12
|
||||
- API key visible in code
|
||||
- Recommendation: Use environment variables
|
||||
|
||||
3. Missing input validation in api/users.py:78
|
||||
- User input directly used in file paths
|
||||
- Recommendation: Add path sanitization
|
||||
|
||||
Priority: Fix item 1 (critical) immediately."
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔨 Creating a New Skill
|
||||
|
||||
### Step 1: Plan
|
||||
|
||||
Before coding, define:
|
||||
|
||||
1. **Purpose**: What problem does this solve?
|
||||
2. **Activation**: What phrases trigger it?
|
||||
3. **Scope**: What's included/excluded?
|
||||
4. **Tools**: Which tools will it use?
|
||||
5. **Integration**: How does it work with existing skills?
|
||||
|
||||
### Step 2: Create Structure
|
||||
|
||||
```bash
|
||||
# In existing plugin or create new
|
||||
mkdir -p {plugin-name}-plugin/.claude-plugin
|
||||
mkdir -p {plugin-name}-plugin/{skill-name}
|
||||
|
||||
# Create files
|
||||
touch {plugin-name}-plugin/.claude-plugin/plugin.json
|
||||
touch {plugin-name}-plugin/{skill-name}/SKILL.md
|
||||
touch {plugin-name}-plugin/README.md
|
||||
```
|
||||
|
||||
### Step 3: Write SKILL.md
|
||||
|
||||
Start with the template above. Be specific about:
|
||||
- **When to activate** (trigger phrases)
|
||||
- **What to do** (step-by-step workflow)
|
||||
- **How to do it** (tool usage patterns)
|
||||
- **Success criteria** (when is it done?)
|
||||
|
||||
### Step 4: Update plugin.json
|
||||
|
||||
Add your skill to the skills array:
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "skill-name",
|
||||
"source": "./skill-directory",
|
||||
"description": "Activates when users [trigger phrase]. Does [what it does].",
|
||||
"gitignored": false,
|
||||
"project": false
|
||||
}
|
||||
```
|
||||
|
||||
### Step 5: Document
|
||||
|
||||
Create/update README.md with:
|
||||
- Skill purpose and benefits
|
||||
- Activation examples
|
||||
- Usage tips
|
||||
- Integration notes
|
||||
|
||||
### Step 6: Test
|
||||
|
||||
Test the skill with various inputs:
|
||||
- ✅ Natural activation phrases
|
||||
- ✅ Edge cases
|
||||
- ✅ Error conditions
|
||||
- ✅ Integration with other skills
|
||||
|
||||
### Step 7: Add to Marketplace
|
||||
|
||||
Update `.claude-plugin/marketplace.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"plugins": [
|
||||
{
|
||||
"name": "your-plugin-name",
|
||||
"source": "./your-plugin-directory",
|
||||
"description": "Clear description",
|
||||
"version": "1.0.0",
|
||||
"author": {
|
||||
"name": "your-name"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📚 Reference Materials
|
||||
|
||||
Skills can include reference materials in `references/` directory:
|
||||
|
||||
```
|
||||
skill-name/
|
||||
├── SKILL.md
|
||||
└── references/
|
||||
├── best-practices.md # Industry best practices
|
||||
├── examples.md # Code examples
|
||||
├── patterns.md # Design patterns
|
||||
└── troubleshooting.md # Common issues
|
||||
```
|
||||
|
||||
Claude can read these during skill execution for additional context.
|
||||
|
||||
**When to use references:**
|
||||
- Detailed technical specifications
|
||||
- Code examples and templates
|
||||
- Best practices guides
|
||||
- Troubleshooting information
|
||||
- Pattern libraries
|
||||
|
||||
**Examples from existing skills:**
|
||||
- `visual-html-creator/references/design_patterns.md` - Design patterns for visual docs
|
||||
- `visual-html-creator/references/svg_library.md` - SVG component library
|
||||
- `feature-planning/references/planning-best-practices.md` - Planning guide
|
||||
|
||||
---
|
||||
|
||||
## 🤖 Creating Agents
|
||||
|
||||
Agents are specialized sub-agents with specific purposes.
|
||||
|
||||
### Agent Structure
|
||||
|
||||
```
|
||||
agents/
|
||||
└── {agent-name}/
|
||||
└── AGENT.md
|
||||
```
|
||||
|
||||
### AGENT.md Template
|
||||
|
||||
```markdown
|
||||
# {Agent Name}
|
||||
|
||||
## Purpose
|
||||
What this agent specializes in.
|
||||
|
||||
## When to Use
|
||||
Scenarios where this agent should be invoked.
|
||||
|
||||
## Capabilities
|
||||
What this agent can do:
|
||||
- Capability 1
|
||||
- Capability 2
|
||||
|
||||
## Approach
|
||||
How the agent should work:
|
||||
1. Step 1
|
||||
2. Step 2
|
||||
|
||||
## Tools
|
||||
Tools this agent has access to.
|
||||
|
||||
## Constraints
|
||||
What this agent should NOT do.
|
||||
|
||||
## Output
|
||||
What this agent should return.
|
||||
```
|
||||
|
||||
### Agent Best Practices
|
||||
|
||||
1. **Focused purpose**: Agents should have narrow, well-defined scope
|
||||
2. **Clear constraints**: Explicitly state what agent should NOT do
|
||||
3. **Efficient model**: Use Haiku for cost-effective execution when possible
|
||||
4. **Clear output**: Define what agent should return to parent skill
|
||||
|
||||
**Example from plan-implementer:**
|
||||
- **Purpose**: Implement code from detailed plans
|
||||
- **Model**: claude-3-5-haiku (cost-effective)
|
||||
- **Constraints**: No feature creep, stick to plan
|
||||
- **Output**: Working implementation with tests
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Quality Standards
|
||||
|
||||
### Required Elements
|
||||
|
||||
Every skill must have:
|
||||
- ✅ Clear purpose statement
|
||||
- ✅ Specific activation phrases
|
||||
- ✅ Step-by-step approach
|
||||
- ✅ Tool usage specification
|
||||
- ✅ Success criteria
|
||||
- ✅ Example interactions
|
||||
- ✅ User-facing documentation
|
||||
|
||||
### Best Practices
|
||||
|
||||
1. **Descriptive names**: `code-auditor` not `checker`
|
||||
2. **Natural activation**: Match how users naturally phrase requests
|
||||
3. **Tool-rich**: Use multiple tools effectively
|
||||
4. **Well-documented**: Both in SKILL.md and README
|
||||
5. **Integration-aware**: Know how to work with other skills
|
||||
6. **Error-resilient**: Handle edge cases gracefully
|
||||
7. **User-friendly**: Explain what's happening, provide clear output
|
||||
|
||||
### Common Pitfalls to Avoid
|
||||
|
||||
❌ **Too broad**: Skill tries to do too many unrelated things
|
||||
❌ **Manual activation**: Requires slash command or explicit invocation
|
||||
❌ **Tool-poor**: Only uses basic tools, doesn't leverage full toolkit
|
||||
❌ **Undocumented**: Unclear when/how to use
|
||||
❌ **Silent**: Doesn't explain what it's doing
|
||||
❌ **Isolated**: Doesn't integrate with other skills
|
||||
❌ **Vague**: Unclear success criteria or output
|
||||
|
||||
---
|
||||
|
||||
## 📦 Version Management
|
||||
|
||||
### Semantic Versioning
|
||||
|
||||
Use semantic versioning: `MAJOR.MINOR.PATCH`
|
||||
|
||||
- **MAJOR**: Breaking changes to skill interface
|
||||
- **MINOR**: New features, backward compatible
|
||||
- **PATCH**: Bug fixes, no new features
|
||||
|
||||
### CHANGELOG.md
|
||||
|
||||
Maintain a changelog:
|
||||
|
||||
```markdown
|
||||
# Changelog
|
||||
|
||||
## [1.1.0] - 2025-10-22
|
||||
|
||||
### Added
|
||||
- New skill: feature-planning
|
||||
- Agent: plan-implementer
|
||||
|
||||
### Changed
|
||||
- Improved git-pushing commit messages
|
||||
|
||||
### Fixed
|
||||
- Bug in test-fixing error grouping
|
||||
|
||||
## [1.0.0] - 2025-10-15
|
||||
|
||||
### Added
|
||||
- Initial release with 4 skills
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Workflow for Updates
|
||||
|
||||
### Adding a New Skill to Existing Plugin
|
||||
|
||||
1. Create skill directory and SKILL.md
|
||||
2. Update plugin.json (add to skills array)
|
||||
3. Update README.md (document new skill)
|
||||
4. Update CHANGELOG.md (note addition)
|
||||
5. Increment version (MINOR version bump)
|
||||
6. Test activation and functionality
|
||||
7. Commit with descriptive message
|
||||
|
||||
### Creating a New Plugin
|
||||
|
||||
1. Create plugin directory structure
|
||||
2. Create `.claude-plugin/plugin.json`
|
||||
3. Create initial skill(s)
|
||||
4. Create README.md and CHANGELOG.md
|
||||
5. Update marketplace.json
|
||||
6. Test thoroughly
|
||||
7. Document in main README if appropriate
|
||||
8. Commit and create PR if sharing
|
||||
|
||||
---
|
||||
|
||||
## 🧪 Testing Checklist
|
||||
|
||||
Before considering a skill complete:
|
||||
|
||||
- [ ] SKILL.md includes all required sections
|
||||
- [ ] Activation phrases are natural and clear
|
||||
- [ ] Tool usage is comprehensive and appropriate
|
||||
- [ ] Success criteria are well-defined
|
||||
- [ ] README.md documents the skill for users
|
||||
- [ ] plugin.json correctly references the skill
|
||||
- [ ] Works with natural language activation
|
||||
- [ ] Handles edge cases gracefully
|
||||
- [ ] Integrates well with related skills
|
||||
- [ ] Example interactions are realistic
|
||||
- [ ] Reference materials included if needed
|
||||
- [ ] Version updated appropriately
|
||||
- [ ] CHANGELOG updated
|
||||
|
||||
---
|
||||
|
||||
## 💡 Skill Ideas & Patterns
|
||||
|
||||
### Analysis Skills Pattern
|
||||
|
||||
Skills that analyze and report:
|
||||
- Explore thoroughly first
|
||||
- Use multiple analysis dimensions
|
||||
- Provide specific findings with file:line references
|
||||
- Prioritize recommendations
|
||||
- Include both quick wins and long-term improvements
|
||||
|
||||
**Examples:** code-auditor, conversation-analyzer
|
||||
|
||||
### Setup/Bootstrap Skills Pattern
|
||||
|
||||
Skills that configure or initialize:
|
||||
- Ask clarifying questions upfront
|
||||
- Show plan before executing
|
||||
- Work systematically through areas
|
||||
- Explain each change
|
||||
- Provide post-setup guidance
|
||||
|
||||
**Examples:** project-bootstrapper
|
||||
|
||||
### Documentation Skills Pattern
|
||||
|
||||
Skills that generate documentation:
|
||||
- Explore to understand structure
|
||||
- Create comprehensive coverage
|
||||
- Include visual elements (diagrams)
|
||||
- Provide concrete examples
|
||||
- Make navigable and organized
|
||||
|
||||
**Examples:** codebase-documenter, visual-html-creator
|
||||
|
||||
### Workflow Automation Pattern
|
||||
|
||||
Skills that handle repetitive workflows:
|
||||
- Minimize user input required
|
||||
- Follow best practices automatically
|
||||
- Handle edge cases
|
||||
- Provide clear status/results
|
||||
- Integrate with related workflows
|
||||
|
||||
**Examples:** git-pushing, test-fixing
|
||||
|
||||
---
|
||||
|
||||
## 🎓 Learning from Existing Skills
|
||||
|
||||
### Study These Examples
|
||||
|
||||
**Best activation phrases:**
|
||||
- Look at engineering-workflow-skills for natural triggers
|
||||
- Notice how they match common developer requests
|
||||
|
||||
**Best tool usage:**
|
||||
- code-auditor: Comprehensive tool orchestration
|
||||
- feature-planning: Effective use of AskUserQuestion
|
||||
- plan-implementer: Focused agent with clear constraints
|
||||
|
||||
**Best documentation:**
|
||||
- visual-documentation-skills: Excellent README structure
|
||||
- productivity-skills: Clear activation examples
|
||||
|
||||
**Best integration:**
|
||||
- feature-planning + plan-implementer: Skill → Agent handoff
|
||||
- All engineering-workflow skills: Complementary capabilities
|
||||
|
||||
---
|
||||
|
||||
## 🚀 When Working on This Repository
|
||||
|
||||
### Your Role
|
||||
|
||||
You are helping develop **high-quality, reusable skills** for the Claude Code community.
|
||||
|
||||
**Priorities:**
|
||||
1. **Skills first**: ALWAYS use available skills before manual implementation
|
||||
2. **Quality over speed**: Take time to design well
|
||||
3. **User experience**: Natural activation, clear output
|
||||
4. **Documentation**: Both technical (SKILL.md) and user-facing (README)
|
||||
5. **Integration**: Consider how skills work together
|
||||
6. **Standards**: Follow established patterns and structure
|
||||
|
||||
### Critical Working Guidelines
|
||||
|
||||
**1. ALWAYS use skills when available**
|
||||
|
||||
For ANY task in this repository:
|
||||
- Check if a skill can handle it FIRST
|
||||
- Use git-pushing for all git operations
|
||||
- Use feature-planning for complex features
|
||||
- Use test-fixing for test failures
|
||||
- **Use skill-creator for creating new skills** - ensures proper structure
|
||||
- Never implement manually when a skill exists
|
||||
|
||||
**CRITICAL: When creating new skills:**
|
||||
- ALWAYS use the skill-creator skill from example-skills
|
||||
- Never manually create skill structure
|
||||
- skill-creator ensures all required files and structure are correct
|
||||
- Manual creation often leads to missing files (skill.json, proper directories, etc.)
|
||||
|
||||
**2. NEVER create markdown files unless explicitly requested by the user.**
|
||||
|
||||
This includes:
|
||||
- ❌ Don't create README.md, CHANGELOG.md, or other docs proactively
|
||||
- ❌ Don't create example files or guides without being asked
|
||||
- ❌ Don't create markdown documentation as a "helpful addition"
|
||||
- ✅ Only create .md files when the user specifically requests them
|
||||
- ✅ Focus on code and functionality first, documentation when asked
|
||||
|
||||
**Exception:** When creating a new skill/plugin per user request, the required files (SKILL.md, plugin.json, README.md) are part of the deliverable and should be created.
|
||||
|
||||
### Making Changes
|
||||
|
||||
**When adding features:**
|
||||
1. Understand the existing pattern
|
||||
2. Design before implementing
|
||||
3. Follow structure conventions
|
||||
4. Document thoroughly
|
||||
5. Update version and changelog
|
||||
6. Test comprehensively
|
||||
|
||||
**When improving existing skills:**
|
||||
1. Read SKILL.md fully to understand intent
|
||||
2. Maintain backward compatibility if possible
|
||||
3. Update documentation
|
||||
4. Test that existing use cases still work
|
||||
5. Version bump appropriately
|
||||
|
||||
### Code Quality
|
||||
|
||||
**For SKILL.md files:**
|
||||
- Clear, concise language
|
||||
- Specific instructions, not vague guidelines
|
||||
- Concrete examples
|
||||
- Realistic scenarios
|
||||
|
||||
**For reference materials:**
|
||||
- Well-organized
|
||||
- Comprehensive but focused
|
||||
- Practical examples
|
||||
- Up-to-date best practices
|
||||
|
||||
---
|
||||
|
||||
## 📋 Quick Reference
|
||||
|
||||
### File Locations (Critical!)
|
||||
|
||||
```
|
||||
✅ CORRECT:
|
||||
plugin-name-plugin/.claude-plugin/plugin.json
|
||||
plugin-name-plugin/skill-name/SKILL.md
|
||||
|
||||
❌ WRONG:
|
||||
plugin-name-plugin/plugin.json # Wrong location
|
||||
plugin-name-plugin/skill-name/README.md # Wrong filename (use SKILL.md)
|
||||
```
|
||||
|
||||
### Skill Naming
|
||||
|
||||
- Use kebab-case: `code-auditor`, `feature-planning`
|
||||
- Be descriptive: `test-fixing` not `fixer`
|
||||
- Match purpose: Name should indicate what it does
|
||||
|
||||
### Description Writing
|
||||
|
||||
**In plugin.json:**
|
||||
Focus on when it activates and what it does:
|
||||
```
|
||||
"description": "Activates when users want to [trigger]. Provides [benefit]."
|
||||
```
|
||||
|
||||
**In SKILL.md:**
|
||||
Focus on how it works and detailed approach.
|
||||
|
||||
**In README.md:**
|
||||
Focus on user benefits and practical examples.
|
||||
|
||||
---
|
||||
|
||||
## 🎁 Remember
|
||||
|
||||
**You're building tools that developers will use every day.**
|
||||
|
||||
Make them:
|
||||
- 🎯 **Purposeful** - Clear, focused scope
|
||||
- 🗣️ **Natural** - Activate with natural language
|
||||
- 🔧 **Powerful** - Leverage all available tools
|
||||
- 📖 **Well-documented** - Easy to understand and use
|
||||
- 🤝 **Integrated** - Work well with other skills
|
||||
- ✨ **Delightful** - Make developers' lives easier
|
||||
|
||||
---
|
||||
|
||||
*This repository analysis is based on existing plugins: engineering-workflow-skills, visual-documentation-skills, and productivity-skills.*
|
||||
@@ -1,136 +0,0 @@
|
||||
# Claude Skills Marketplace - Complete Structure
|
||||
|
||||
## Repository Overview
|
||||
|
||||
```
|
||||
claude-skills-marketplace/
|
||||
├── .claude-plugin/
|
||||
│ └── marketplace.json ← Marketplace manifest (2 plugins registered)
|
||||
│
|
||||
├── assets/
|
||||
│ └── skill-loading.gif ← Demo asset
|
||||
│
|
||||
├── engineering-workflow-plugin/ ← Plugin 1: Engineering Workflows
|
||||
│ ├── .claude-plugin/
|
||||
│ │ └── plugin.json ← Plugin manifest v1.1.0
|
||||
│ ├── agents/
|
||||
│ │ └── plan-implementer.md ← Haiku-powered implementation agent
|
||||
│ ├── skills/
|
||||
│ │ ├── feature-planning/
|
||||
│ │ │ ├── references/
|
||||
│ │ │ └── SKILL.md
|
||||
│ │ ├── git-pushing/
|
||||
│ │ │ └── SKILL.md
|
||||
│ │ ├── review-implementing/
|
||||
│ │ │ └── SKILL.md
|
||||
│ │ └── test-fixing/
|
||||
│ │ └── SKILL.md
|
||||
│ ├── CHANGELOG.md
|
||||
│ ├── CONTRIBUTING.md
|
||||
│ └── SETUP.md
|
||||
│
|
||||
├── visual-documentation-plugin/ ← Plugin 2: Visual Documentation ✨ NEW
|
||||
│ ├── .claude-plugin/
|
||||
│ │ └── plugin.json ← Plugin manifest v1.0.0
|
||||
│ ├── skills/
|
||||
│ │ └── visual-html-creator/ ← HTML visualization skill
|
||||
│ │ ├── assets/
|
||||
│ │ │ └── templates/
|
||||
│ │ │ ├── base_template.html
|
||||
│ │ │ ├── flowchart_components.html
|
||||
│ │ │ ├── dashboard_components.html
|
||||
│ │ │ └── timeline_components.html
|
||||
│ │ ├── references/
|
||||
│ │ │ ├── design_patterns.md
|
||||
│ │ │ └── svg_library.md
|
||||
│ │ └── SKILL.md
|
||||
│ ├── CHANGELOG.md
|
||||
│ ├── FILE_STRUCTURE.txt
|
||||
│ ├── README.md
|
||||
│ └── SETUP.md
|
||||
│
|
||||
├── LICENSE ← Apache 2.0
|
||||
└── README.md ← Main documentation
|
||||
```
|
||||
|
||||
## Statistics
|
||||
|
||||
### Engineering Workflow Plugin
|
||||
- **Skills:** 4 (feature-planning, git-pushing, review-implementing, test-fixing)
|
||||
- **Agents:** 1 (plan-implementer)
|
||||
- **Version:** 1.1.0
|
||||
|
||||
### Visual Documentation Plugin ✨ NEW
|
||||
- **Skills:** 1 (visual-html-creator)
|
||||
- **Templates:** 4 HTML component libraries
|
||||
- **References:** 2 comprehensive guides
|
||||
- **Lines of Code:** ~2,700+
|
||||
- **Version:** 1.0.0
|
||||
|
||||
### Overall Marketplace
|
||||
- **Total Plugins:** 2
|
||||
- **Total Skills:** 5
|
||||
- **Total Agents:** 1
|
||||
- **Total Files:** 22
|
||||
|
||||
## Plugin Comparison
|
||||
|
||||
| Feature | Engineering Workflow | Visual Documentation |
|
||||
|---------|---------------------|---------------------|
|
||||
| Primary Focus | Software engineering workflows | Visual HTML documentation |
|
||||
| Skills Count | 4 | 1 |
|
||||
| Agents | 1 | 0 |
|
||||
| Bundled Assets | Minimal | Extensive (templates, references) |
|
||||
| Use Case | Git, testing, reviews, planning | Diagrams, dashboards, timelines |
|
||||
| Complexity | Medium | High |
|
||||
| Documentation | Standard | Comprehensive |
|
||||
|
||||
## Installation Commands
|
||||
|
||||
```bash
|
||||
# Install everything
|
||||
/plugin marketplace add mhattingpete/claude-skills-marketplace
|
||||
|
||||
# Install engineering workflows only
|
||||
/plugin marketplace add mhattingpete/claude-skills-marketplace/engineering-workflow-plugin
|
||||
|
||||
# Install visual documentation only
|
||||
/plugin marketplace add mhattingpete/claude-skills-marketplace/visual-documentation-plugin
|
||||
```
|
||||
|
||||
## Git Status
|
||||
|
||||
**Modified Files:**
|
||||
- `.claude-plugin/marketplace.json` - Added visual-documentation-plugin
|
||||
- `README.md` - Added plugin documentation
|
||||
|
||||
**New Directory:**
|
||||
- `visual-documentation-plugin/` - Complete new plugin (11 files)
|
||||
|
||||
**Ready to Commit:** Yes ✅
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. Review the changes:
|
||||
```bash
|
||||
git diff .claude-plugin/marketplace.json
|
||||
git diff README.md
|
||||
```
|
||||
|
||||
2. Commit and push:
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "feat: add visual-documentation-plugin with visual-html-creator skill"
|
||||
git push
|
||||
```
|
||||
|
||||
3. Test the skill:
|
||||
```
|
||||
"Create a visual HTML dashboard with metrics"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**Created:** 2025-01-20
|
||||
**Status:** Ready for deployment
|
||||
**Repository:** github.com/mhattingpete/claude-skills-marketplace
|
||||
@@ -0,0 +1,119 @@
|
||||
# Engineering Workflow Skills
|
||||
|
||||
Automate common software engineering workflows including feature planning, testing, git operations, and code review implementation.
|
||||
|
||||
**Version:** 1.1.0
|
||||
|
||||
---
|
||||
|
||||
## Skills
|
||||
|
||||
### 1. feature-planning
|
||||
|
||||
**Activates when you say:**
|
||||
- "Add user authentication"
|
||||
- "Build a dashboard"
|
||||
- "Implement X feature"
|
||||
- "Plan how to do X"
|
||||
|
||||
**What it does:**
|
||||
- Asks clarifying questions about requirements
|
||||
- Explores codebase for existing patterns
|
||||
- Creates detailed implementation plan
|
||||
- Hands off to plan-implementer agent for execution
|
||||
|
||||
---
|
||||
|
||||
### 2. test-fixing
|
||||
|
||||
**Activates when you say:**
|
||||
- "Fix the tests"
|
||||
- "Tests are failing"
|
||||
- "Make the test suite green"
|
||||
|
||||
**What it does:**
|
||||
- Runs test suite to identify failures
|
||||
- Groups errors by type/cause
|
||||
- Fixes issues systematically
|
||||
- Verifies all tests pass
|
||||
|
||||
---
|
||||
|
||||
### 3. git-pushing
|
||||
|
||||
**Activates when you say:**
|
||||
- "Push these changes"
|
||||
- "Commit and push"
|
||||
- "Create a PR"
|
||||
|
||||
**What it does:**
|
||||
- Stages all changes
|
||||
- Generates conventional commit message
|
||||
- Pushes to remote
|
||||
- Creates pull request (if requested)
|
||||
|
||||
---
|
||||
|
||||
### 4. review-implementing
|
||||
|
||||
**Activates when you say:**
|
||||
- "Implement this review feedback"
|
||||
- "Address these comments"
|
||||
- "Apply review suggestions"
|
||||
|
||||
**What it does:**
|
||||
- Parses reviewer feedback
|
||||
- Creates todo list for each item
|
||||
- Implements changes systematically
|
||||
- Verifies all feedback addressed
|
||||
|
||||
---
|
||||
|
||||
## Agent
|
||||
|
||||
### plan-implementer
|
||||
|
||||
Focused agent for implementing code from detailed plans. Uses Haiku model for cost-effective execution.
|
||||
|
||||
**Used by:** feature-planning skill
|
||||
**Purpose:** Execute discrete implementation tasks with strict scope adherence
|
||||
|
||||
---
|
||||
|
||||
## Workflow Example
|
||||
|
||||
```
|
||||
User: "Add user authentication"
|
||||
↓
|
||||
feature-planning → creates plan, asks questions
|
||||
↓
|
||||
plan-implementer → implements each task
|
||||
↓
|
||||
test-fixing → fixes any test failures
|
||||
↓
|
||||
git-pushing → commits and pushes changes
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
Add to your `.claude-plugin/marketplace.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"plugins": [
|
||||
{
|
||||
"name": "engineering-workflow-skills",
|
||||
"source": "github:anthropics/claude-skills-marketplace/engineering-workflow-plugin",
|
||||
"version": "1.1.0"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Author
|
||||
|
||||
**mhattingpete**
|
||||
@@ -1,248 +0,0 @@
|
||||
# Setting Up Your Claude Skills Marketplace
|
||||
|
||||
This guide walks through publishing your Skills marketplace on GitHub.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- GitHub account
|
||||
- Git installed locally
|
||||
- Skills repository created at `~/Documents/Repos/claude-skills-marketplace`
|
||||
|
||||
## Step 1: Initialize Git Repository
|
||||
|
||||
```bash
|
||||
cd ~/Documents/Repos/claude-skills-marketplace
|
||||
|
||||
# Initialize git
|
||||
git init
|
||||
|
||||
# Add all files
|
||||
git add .
|
||||
|
||||
# Create initial commit
|
||||
git commit -m "feat: initial Skills marketplace with git-pushing, test-fixing, and review-implementing
|
||||
|
||||
Includes:
|
||||
- Three production-ready Skills
|
||||
- Documentation and contributing guidelines
|
||||
- Apache 2.0 license
|
||||
- Installation instructions
|
||||
|
||||
🤖 Generated with [Claude Code](https://claude.com/claude-code)
|
||||
|
||||
Co-Authored-By: Claude <noreply@anthropic.com>"
|
||||
```
|
||||
|
||||
## Step 2: Create GitHub Repository
|
||||
|
||||
### Option A: Using GitHub CLI
|
||||
|
||||
```bash
|
||||
# Install gh if not already installed
|
||||
# macOS: brew install gh
|
||||
|
||||
# Authenticate
|
||||
gh auth login
|
||||
|
||||
# Create public repository
|
||||
gh repo create claude-skills-marketplace --public --source=. --remote=origin
|
||||
|
||||
# Push to GitHub
|
||||
git push -u origin main
|
||||
```
|
||||
|
||||
### Option B: Using GitHub Web Interface
|
||||
|
||||
1. Go to https://github.com/new
|
||||
2. Repository name: `claude-skills-marketplace`
|
||||
3. Description: "Claude Code Skills for software engineering workflows"
|
||||
4. Visibility: **Public**
|
||||
5. Do NOT initialize with README (we already have one)
|
||||
6. Click "Create repository"
|
||||
|
||||
Then push:
|
||||
```bash
|
||||
git remote add origin git@github.com:mhattingpete/claude-skills-marketplace.git
|
||||
git branch -M main
|
||||
git push -u origin main
|
||||
```
|
||||
|
||||
## Step 3: Configure Repository
|
||||
|
||||
### Add Topics
|
||||
|
||||
Add GitHub topics for discoverability:
|
||||
|
||||
1. Go to repository settings
|
||||
2. Under "About", click ⚙️
|
||||
3. Add topics:
|
||||
- `claude-code`
|
||||
- `claude-skills`
|
||||
- `ai-agents`
|
||||
- `anthropic`
|
||||
- `developer-tools`
|
||||
- `automation`
|
||||
|
||||
### Update Repository Description
|
||||
|
||||
```
|
||||
Claude Code Skills for software engineering workflows - Git automation, testing, and code review
|
||||
```
|
||||
|
||||
### Add Website Link
|
||||
|
||||
```
|
||||
https://docs.claude.com/en/docs/claude-code/skills
|
||||
```
|
||||
|
||||
## Step 4: Enable GitHub Pages (Optional)
|
||||
|
||||
If you want a website for your Skills:
|
||||
|
||||
1. Settings → Pages
|
||||
2. Source: Deploy from branch
|
||||
3. Branch: `main` / `root`
|
||||
4. Save
|
||||
|
||||
GitHub will generate a site at: `https://mhattingpete.github.io/claude-skills-marketplace`
|
||||
|
||||
## Step 5: Test Installation
|
||||
|
||||
### Via Plugin Marketplace (Once Registered)
|
||||
|
||||
```bash
|
||||
# In Claude Code
|
||||
/plugin marketplace add mhattingpete/claude-skills-marketplace
|
||||
```
|
||||
|
||||
Note: This requires registering with Claude Code plugin system (contact Anthropic or check docs).
|
||||
|
||||
### Manual Installation
|
||||
|
||||
```bash
|
||||
# Clone to test
|
||||
git clone https://github.com/mhattingpete/claude-skills-marketplace.git /tmp/test-skills
|
||||
|
||||
# Copy a skill
|
||||
cp -r /tmp/test-skills/git-pushing ~/.claude/skills/
|
||||
|
||||
# Test in Claude Code
|
||||
# Say: "Push these changes"
|
||||
# The git-pushing skill should activate
|
||||
```
|
||||
|
||||
## Step 6: Promote Your Marketplace
|
||||
|
||||
### Add to README Badges
|
||||
|
||||
```markdown
|
||||

|
||||

|
||||

|
||||
```
|
||||
|
||||
### Share Links
|
||||
|
||||
- Anthropic Claude community
|
||||
- Reddit: r/ClaudeAI
|
||||
- Twitter/X with #ClaudeCode hashtag
|
||||
- Discord communities
|
||||
|
||||
### Create Announcement
|
||||
|
||||
Example post:
|
||||
```
|
||||
🚀 Just published claude-skills-marketplace - a collection of Claude Code
|
||||
Skills for common dev workflows!
|
||||
|
||||
Includes:
|
||||
✅ Git automation with conventional commits
|
||||
✅ Smart test fixing with error grouping
|
||||
✅ Code review feedback implementation
|
||||
|
||||
All skills use natural language - no need to memorize commands!
|
||||
|
||||
Check it out: https://github.com/mhattingpete/claude-skills-marketplace
|
||||
```
|
||||
|
||||
## Maintenance
|
||||
|
||||
### Adding New Skills
|
||||
|
||||
```bash
|
||||
# Create new skill directory
|
||||
mkdir my-new-skill
|
||||
|
||||
# Create SKILL.md
|
||||
# ... (following guidelines in CONTRIBUTING.md)
|
||||
|
||||
# Test locally
|
||||
cp -r my-new-skill ~/.claude/skills/
|
||||
|
||||
# Commit and push
|
||||
git add my-new-skill
|
||||
git commit -m "feat(skills): add my-new-skill for X functionality"
|
||||
git push
|
||||
```
|
||||
|
||||
### Accepting Contributions
|
||||
|
||||
1. Review PRs for:
|
||||
- Valid SKILL.md format
|
||||
- Clear description with triggers
|
||||
- Follows best practices
|
||||
- Updated README
|
||||
|
||||
2. Test the skill locally
|
||||
|
||||
3. Merge if quality standards met
|
||||
|
||||
### Versioning
|
||||
|
||||
Consider semantic versioning for major updates:
|
||||
|
||||
```bash
|
||||
# Tag releases
|
||||
git tag -a v1.0.0 -m "Release v1.0.0: Initial three skills"
|
||||
git push --tags
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Skills Don't Load
|
||||
|
||||
- Verify YAML frontmatter is valid
|
||||
- Check file is named `SKILL.md` (case-sensitive)
|
||||
- Ensure description field exists
|
||||
|
||||
### Installation Issues
|
||||
|
||||
- Confirm repository is public
|
||||
- Check file permissions (should be readable)
|
||||
- Verify directory structure matches examples
|
||||
|
||||
### Activation Problems
|
||||
|
||||
- Review description for clear triggers
|
||||
- Test with exact phrases from description
|
||||
- Add more activation examples
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. **Create more Skills**: Identify common workflows in your projects
|
||||
2. **Gather feedback**: Ask users what they'd like automated
|
||||
3. **Contribute upstream**: Share generalized Skills with Anthropic
|
||||
4. **Build community**: Encourage contributions
|
||||
|
||||
## Resources
|
||||
|
||||
- [Claude Code Documentation](https://docs.claude.com/en/docs/claude-code/skills)
|
||||
- [Anthropic Skills Repo](https://github.com/anthropics/skills)
|
||||
- [Skills Best Practices](https://docs.claude.com/en/docs/agents-and-tools/agent-skills/best-practices.md)
|
||||
|
||||
## Support
|
||||
|
||||
Questions or issues?
|
||||
- Open an issue on GitHub
|
||||
- Check Claude Code discussions
|
||||
- Contact via repository discussions
|
||||
@@ -17,19 +17,49 @@ Automatically activate when the user:
|
||||
|
||||
## Workflow
|
||||
|
||||
### 1. Check Git Status
|
||||
### Fast Path (Recommended)
|
||||
|
||||
Use the automated script for maximum speed:
|
||||
|
||||
```bash
|
||||
bash scripts/smart_commit.sh
|
||||
```
|
||||
|
||||
This script handles:
|
||||
- ✅ Staging all changes
|
||||
- ✅ Auto-generating conventional commit messages
|
||||
- ✅ Adding Claude Code footer
|
||||
- ✅ Pushing to remote (with -u for new branches)
|
||||
- ✅ Showing PR link for GitHub repos
|
||||
|
||||
**With custom message:**
|
||||
```bash
|
||||
bash scripts/smart_commit.sh "feat: add new feature"
|
||||
```
|
||||
|
||||
The script automatically:
|
||||
- Determines commit type (feat/fix/docs/test/chore/refactor)
|
||||
- Extracts scope from changed files
|
||||
- Handles new vs existing branches
|
||||
- Shows colored output for better UX
|
||||
|
||||
### Manual Path (Fallback)
|
||||
|
||||
Use when script is unavailable or custom workflow needed:
|
||||
|
||||
**1. Check Git Status**
|
||||
|
||||
Run `git status` to understand:
|
||||
- Which files have changed
|
||||
- What will be committed
|
||||
- Current branch name
|
||||
|
||||
### 2. Stage Changes
|
||||
**2. Stage Changes**
|
||||
|
||||
- Run `git add .` to stage all changes
|
||||
- Alternatively, stage specific files if partial commit is needed
|
||||
|
||||
### 3. Create Commit Message
|
||||
**3. Create Commit Message**
|
||||
|
||||
**If user provided a message:**
|
||||
- Use it directly
|
||||
@@ -60,12 +90,13 @@ EOF
|
||||
)"
|
||||
```
|
||||
|
||||
### 4. Push to Remote
|
||||
**4. Push to Remote**
|
||||
|
||||
- Run `git push` to push commits
|
||||
- If new branch, use `git push -u origin <branch>`
|
||||
- If push fails due to diverged branches, inform user and ask how to proceed
|
||||
|
||||
### 5. Confirm Success
|
||||
**5. Confirm Success**
|
||||
|
||||
- Report commit hash
|
||||
- Summarize what was committed
|
||||
|
||||
@@ -0,0 +1,153 @@
|
||||
#!/bin/bash
|
||||
# Smart Git Commit Script for git-pushing skill
|
||||
# Handles staging, commit message generation, and pushing
|
||||
|
||||
set -e # Exit on error
|
||||
|
||||
# Colors for output
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
NC='\033[0m' # No Color
|
||||
|
||||
# Function to print colored messages
|
||||
info() { echo -e "${GREEN}→${NC} $1"; }
|
||||
warn() { echo -e "${YELLOW}⚠${NC} $1"; }
|
||||
error() { echo -e "${RED}✗${NC} $1" >&2; }
|
||||
|
||||
# Get current branch
|
||||
CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
|
||||
info "Current branch: $CURRENT_BRANCH"
|
||||
|
||||
# Check if there are changes
|
||||
if git diff --quiet && git diff --cached --quiet; then
|
||||
warn "No changes to commit"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Stage all changes
|
||||
info "Staging all changes..."
|
||||
git add .
|
||||
|
||||
# Get staged files for commit message analysis
|
||||
STAGED_FILES=$(git diff --cached --name-only)
|
||||
DIFF_STAT=$(git diff --cached --stat)
|
||||
|
||||
# Analyze changes to determine commit type
|
||||
determine_commit_type() {
|
||||
local files="$1"
|
||||
|
||||
# Check for specific patterns
|
||||
if echo "$files" | grep -q "test"; then
|
||||
echo "test"
|
||||
elif echo "$files" | grep -qE "\.(md|txt|rst)$"; then
|
||||
echo "docs"
|
||||
elif echo "$files" | grep -qE "package\.json|requirements\.txt|Cargo\.toml"; then
|
||||
echo "chore"
|
||||
elif git diff --cached | grep -qE "^[\+].*fix|^[\+].*bug"; then
|
||||
echo "fix"
|
||||
elif git diff --cached | grep -qE "^[\+].*refactor"; then
|
||||
echo "refactor"
|
||||
else
|
||||
echo "feat"
|
||||
fi
|
||||
}
|
||||
|
||||
# Analyze files to determine scope
|
||||
determine_scope() {
|
||||
local files="$1"
|
||||
|
||||
# Extract directory or component name
|
||||
local scope=$(echo "$files" | head -1 | cut -d'/' -f1)
|
||||
|
||||
# Check for common patterns
|
||||
if echo "$files" | grep -q "plugin"; then
|
||||
echo "plugin"
|
||||
elif echo "$files" | grep -q "skill"; then
|
||||
echo "skill"
|
||||
elif echo "$files" | grep -q "agent"; then
|
||||
echo "agent"
|
||||
elif [ -n "$scope" ] && [ "$scope" != "." ]; then
|
||||
echo "$scope"
|
||||
else
|
||||
echo ""
|
||||
fi
|
||||
}
|
||||
|
||||
# Generate commit message if not provided
|
||||
if [ -z "$1" ]; then
|
||||
COMMIT_TYPE=$(determine_commit_type "$STAGED_FILES")
|
||||
SCOPE=$(determine_scope "$STAGED_FILES")
|
||||
|
||||
# Count files changed
|
||||
NUM_FILES=$(echo "$STAGED_FILES" | wc -l | xargs)
|
||||
|
||||
# Generate description based on changes
|
||||
if [ "$COMMIT_TYPE" = "docs" ]; then
|
||||
DESCRIPTION="update documentation"
|
||||
elif [ "$COMMIT_TYPE" = "test" ]; then
|
||||
DESCRIPTION="update tests"
|
||||
elif [ "$COMMIT_TYPE" = "chore" ]; then
|
||||
DESCRIPTION="update dependencies"
|
||||
else
|
||||
DESCRIPTION="update $NUM_FILES file(s)"
|
||||
fi
|
||||
|
||||
# Build commit message
|
||||
if [ -n "$SCOPE" ]; then
|
||||
COMMIT_MSG="${COMMIT_TYPE}(${SCOPE}): ${DESCRIPTION}"
|
||||
else
|
||||
COMMIT_MSG="${COMMIT_TYPE}: ${DESCRIPTION}"
|
||||
fi
|
||||
|
||||
info "Generated commit message: $COMMIT_MSG"
|
||||
else
|
||||
COMMIT_MSG="$1"
|
||||
info "Using provided message: $COMMIT_MSG"
|
||||
fi
|
||||
|
||||
# Create commit with Claude Code footer
|
||||
git commit -m "$(cat <<EOF
|
||||
${COMMIT_MSG}
|
||||
|
||||
🤖 Generated with [Claude Code](https://claude.com/claude-code)
|
||||
|
||||
Co-Authored-By: Claude <noreply@anthropic.com>
|
||||
EOF
|
||||
)"
|
||||
|
||||
COMMIT_HASH=$(git rev-parse --short HEAD)
|
||||
info "Created commit: $COMMIT_HASH"
|
||||
|
||||
# Push to remote
|
||||
info "Pushing to origin/$CURRENT_BRANCH..."
|
||||
|
||||
# Check if branch exists on remote
|
||||
if git ls-remote --exit-code --heads origin "$CURRENT_BRANCH" >/dev/null 2>&1; then
|
||||
# Branch exists, just push
|
||||
if git push; then
|
||||
info "Successfully pushed to origin/$CURRENT_BRANCH"
|
||||
echo "$DIFF_STAT"
|
||||
else
|
||||
error "Push failed"
|
||||
exit 1
|
||||
fi
|
||||
else
|
||||
# New branch, push with -u
|
||||
if git push -u origin "$CURRENT_BRANCH"; then
|
||||
info "Successfully pushed new branch to origin/$CURRENT_BRANCH"
|
||||
echo "$DIFF_STAT"
|
||||
|
||||
# Check if it's GitHub and show PR link
|
||||
REMOTE_URL=$(git remote get-url origin)
|
||||
if echo "$REMOTE_URL" | grep -q "github.com"; then
|
||||
REPO=$(echo "$REMOTE_URL" | sed -E 's/.*github\.com[:/](.*)\.git/\1/')
|
||||
warn "Create PR: https://github.com/$REPO/pull/new/$CURRENT_BRANCH"
|
||||
fi
|
||||
else
|
||||
error "Push failed"
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
exit 0
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"name": "productivity-skills",
|
||||
"version": "1.0.0",
|
||||
"description": "Productivity and workflow optimization skills for analyzing usage patterns, auditing code, bootstrapping projects, and generating documentation",
|
||||
"author": {
|
||||
"name": "mhattingpete"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,95 @@
|
||||
# Productivity Skills Plugin
|
||||
|
||||
Workflow optimization skills for analyzing usage patterns, auditing code quality, bootstrapping projects, and generating documentation.
|
||||
|
||||
**Version:** 1.0.0
|
||||
|
||||
---
|
||||
|
||||
## Skills
|
||||
|
||||
### 1. conversation-analyzer
|
||||
|
||||
**Activates when you say:**
|
||||
- "Analyze my conversations"
|
||||
- "How can I improve my workflow"
|
||||
- "Review my Claude Code history"
|
||||
|
||||
**What it does:**
|
||||
- Analyzes conversation history from `~/.claude/history.jsonl`
|
||||
- Identifies patterns, repetitive tasks, and inefficiencies
|
||||
- Provides actionable recommendations
|
||||
|
||||
---
|
||||
|
||||
### 2. code-auditor
|
||||
|
||||
**Activates when you say:**
|
||||
- "Audit the code"
|
||||
- "Check for security issues"
|
||||
- "Review code quality"
|
||||
|
||||
**What it does:**
|
||||
- Comprehensive analysis across 6 dimensions: architecture, quality, security, performance, testing, maintainability
|
||||
- Generates detailed report with file:line references
|
||||
- Prioritizes findings and provides action plan
|
||||
|
||||
---
|
||||
|
||||
### 3. project-bootstrapper
|
||||
|
||||
**Activates when you say:**
|
||||
- "Set up a new project"
|
||||
- "Bootstrap this project"
|
||||
- "Add best practices"
|
||||
|
||||
**What it does:**
|
||||
- Sets up directory structure, git, testing, linting, CI/CD
|
||||
- Creates documentation (README, CONTRIBUTING)
|
||||
- Configures development workflow automation
|
||||
|
||||
---
|
||||
|
||||
### 4. codebase-documenter
|
||||
|
||||
**Activates when you say:**
|
||||
- "Explain this codebase"
|
||||
- "Document the architecture"
|
||||
- "Create developer documentation"
|
||||
|
||||
**What it does:**
|
||||
- Explores codebase and documents architecture, components, data flow
|
||||
- Creates visual diagrams and includes code examples
|
||||
- Generates comprehensive documentation files
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
Add to your `.claude-plugin/marketplace.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"plugins": [
|
||||
{
|
||||
"name": "productivity-skills-plugin",
|
||||
"source": "github:anthropics/claude-skills-marketplace/productivity-skills-plugin",
|
||||
"version": "1.0.0"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Integration
|
||||
|
||||
Works seamlessly with:
|
||||
- **engineering-workflow-skills**: Plan implementations from audit findings, fix issues, commit changes
|
||||
- **visual-documentation-skills**: Create visual diagrams for documentation
|
||||
|
||||
---
|
||||
|
||||
## Author
|
||||
|
||||
**mhattingpete**
|
||||
@@ -0,0 +1,187 @@
|
||||
---
|
||||
name: code-auditor
|
||||
description: Performs comprehensive codebase analysis covering architecture, code quality, security, performance, testing, and maintainability. Use when user wants to audit code quality, identify technical debt, find security issues, assess test coverage, or get a codebase health check. Also activates when user says "audit the code", "check for issues", "review the codebase", "security audit", or similar analysis requests.
|
||||
---
|
||||
|
||||
# Code Auditor Skill
|
||||
|
||||
## Purpose
|
||||
|
||||
Performs comprehensive codebase analysis covering architecture, code quality, security, performance, testing, and maintainability. Provides a detailed audit report with specific findings and prioritized recommendations.
|
||||
|
||||
## When to Use
|
||||
|
||||
This skill automatically activates when users want to:
|
||||
- Understand code quality and technical debt
|
||||
- Identify security vulnerabilities or risks
|
||||
- Find performance bottlenecks
|
||||
- Assess testing coverage and quality
|
||||
- Prepare for major refactoring
|
||||
- Onboard to an unfamiliar codebase
|
||||
- Get a "health check" on their project
|
||||
|
||||
**Activation phrases:**
|
||||
- "audit the code"
|
||||
- "analyze code quality"
|
||||
- "check for issues"
|
||||
- "review the codebase"
|
||||
- "find technical debt"
|
||||
- "security audit"
|
||||
- "performance review"
|
||||
|
||||
## What It Does
|
||||
|
||||
Conducts a thorough analysis across six key dimensions:
|
||||
|
||||
### 1. Architecture & Design
|
||||
- Overall structure and organization
|
||||
- Design patterns in use
|
||||
- Module boundaries and separation of concerns
|
||||
- Dependency management
|
||||
- Architectural decisions and trade-offs
|
||||
|
||||
### 2. Code Quality
|
||||
- Complexity hotspots (cyclomatic complexity)
|
||||
- Code duplication (DRY violations)
|
||||
- Naming conventions and consistency
|
||||
- Documentation coverage
|
||||
- Code smells and anti-patterns
|
||||
|
||||
### 3. Security
|
||||
- Common vulnerabilities (OWASP Top 10)
|
||||
- Input validation and sanitization
|
||||
- Authentication and authorization
|
||||
- Secrets management
|
||||
- Dependency vulnerabilities
|
||||
|
||||
### 4. Performance
|
||||
- Algorithmic complexity issues
|
||||
- Database query optimization
|
||||
- Memory usage patterns
|
||||
- Caching opportunities
|
||||
- Resource leaks
|
||||
|
||||
### 5. Testing
|
||||
- Test coverage assessment
|
||||
- Test quality and effectiveness
|
||||
- Missing test scenarios
|
||||
- Testing patterns and practices
|
||||
- Integration vs unit test balance
|
||||
|
||||
### 6. Maintainability
|
||||
- Technical debt assessment
|
||||
- Coupling and cohesion
|
||||
- Ease of future changes
|
||||
- Onboarding friendliness
|
||||
- Documentation quality
|
||||
|
||||
## Approach
|
||||
|
||||
### Analysis Strategy
|
||||
|
||||
1. **Explore codebase** using Explore agent (thorough mode)
|
||||
2. **Identify patterns** through Grep and Glob
|
||||
3. **Read critical files** for detailed analysis
|
||||
4. **Run static analysis tools** if available (linters, complexity analyzers)
|
||||
5. **Synthesize findings** into actionable report
|
||||
|
||||
### Thoroughness Levels
|
||||
|
||||
Adapts analysis depth based on:
|
||||
- **Quick** (15-30 min): High-level overview, critical issues only
|
||||
- **Standard** (30-60 min): Comprehensive across all dimensions
|
||||
- **Deep** (60+ min): Exhaustive analysis with detailed examples
|
||||
|
||||
User can specify preference, defaults to Standard.
|
||||
|
||||
### Output Format
|
||||
|
||||
Structured markdown report with:
|
||||
|
||||
```markdown
|
||||
# Code Audit Report
|
||||
|
||||
## Executive Summary
|
||||
- Overall health score
|
||||
- Critical issues count
|
||||
- Top 3 priorities
|
||||
|
||||
## Findings by Category
|
||||
|
||||
### Architecture & Design
|
||||
#### 🔴 High Priority
|
||||
- [Finding with file:line reference]
|
||||
- Impact: [description]
|
||||
- Recommendation: [action]
|
||||
|
||||
#### 🟡 Medium Priority
|
||||
...
|
||||
|
||||
### [Other categories]
|
||||
|
||||
## Prioritized Action Plan
|
||||
1. Quick wins (< 1 day)
|
||||
2. Medium-term improvements (1-5 days)
|
||||
3. Long-term initiatives (> 5 days)
|
||||
|
||||
## Metrics
|
||||
- Files analyzed: X
|
||||
- Lines of code: Y
|
||||
- Test coverage: Z%
|
||||
- Complexity hotspots: N
|
||||
```
|
||||
|
||||
## Example Interaction
|
||||
|
||||
```
|
||||
User: "Audit the code quality and find issues"
|
||||
|
||||
Skill:
|
||||
1. Uses Explore agent to map codebase
|
||||
2. Identifies:
|
||||
- 3 files with cyclomatic complexity > 20
|
||||
- SQL injection vulnerability in query builder
|
||||
- 40% code duplication in data processing
|
||||
- Missing tests for critical auth flow
|
||||
- 12 TODO comments indicating incomplete work
|
||||
3. Generates report with:
|
||||
- Critical: Fix SQL injection (file:line)
|
||||
- High: Add auth tests
|
||||
- Medium: Refactor duplicated code
|
||||
- Low: Address TODOs
|
||||
4. Provides action plan with estimates
|
||||
```
|
||||
|
||||
## Tools Used
|
||||
|
||||
- **Task (Explore agent)**: Thorough codebase exploration
|
||||
- **Grep**: Pattern matching for issues (SQL, secrets, TODOs)
|
||||
- **Glob**: Find files by type and pattern
|
||||
- **Read**: Detailed file analysis
|
||||
- **Bash**: Run linters, test coverage tools if available
|
||||
|
||||
## Success Criteria
|
||||
|
||||
- Comprehensive coverage of all six dimensions
|
||||
- Specific file:line references for all findings
|
||||
- Severity/priority ratings (Critical/High/Medium/Low)
|
||||
- Actionable recommendations (not just observations)
|
||||
- Estimated effort for fixes
|
||||
- Both quick wins and long-term improvements identified
|
||||
|
||||
## Integration
|
||||
|
||||
Works well with:
|
||||
- **feature-planning**: For planning technical debt reduction
|
||||
- **test-fixing**: For addressing test gaps identified
|
||||
- **project-bootstrapper**: For setting up quality tooling
|
||||
|
||||
## Configuration
|
||||
|
||||
Can focus analysis on specific areas if requested:
|
||||
- Security-only audit
|
||||
- Performance-only audit
|
||||
- Testing-only assessment
|
||||
- Quick architecture review
|
||||
|
||||
User can specify focus areas, or skill analyzes all dimensions by default.
|
||||
@@ -0,0 +1,260 @@
|
||||
---
|
||||
name: codebase-documenter
|
||||
description: Generates comprehensive documentation explaining how a codebase works, including architecture, key components, data flow, and development guidelines. Use when user wants to understand unfamiliar code, create onboarding docs, document architecture, or explain how the system works. Also activates when user says "explain this codebase", "document the architecture", "how does this code work", "create developer documentation", or similar documentation requests.
|
||||
---
|
||||
|
||||
# Codebase Documenter Skill
|
||||
|
||||
## Purpose
|
||||
|
||||
Generates comprehensive documentation explaining how a codebase works, including architecture, key components, data flow, and development guidelines. Creates onboarding material for new developers or helps existing developers understand unfamiliar code.
|
||||
|
||||
## When to Use
|
||||
|
||||
This skill automatically activates when users want to:
|
||||
- Understand an unfamiliar codebase
|
||||
- Create onboarding documentation
|
||||
- Document architecture and design decisions
|
||||
- Explain how the system works
|
||||
- Prepare for knowledge transfer
|
||||
- Create developer guides
|
||||
- Document technical specifications
|
||||
|
||||
**Activation phrases:**
|
||||
- "explain this codebase"
|
||||
- "document the architecture"
|
||||
- "how does this code work"
|
||||
- "create developer documentation"
|
||||
- "generate codebase overview"
|
||||
- "help me understand this project"
|
||||
- "create onboarding docs"
|
||||
|
||||
## What It Does
|
||||
|
||||
Creates comprehensive documentation covering:
|
||||
|
||||
### 1. Project Overview
|
||||
- **Purpose & Vision**: What the project does and why
|
||||
- **Target Users**: Who uses it and how
|
||||
- **Key Features**: Main functionality
|
||||
- **Technology Stack**: Languages, frameworks, libraries
|
||||
- **Project Status**: Maturity, active development, versioning
|
||||
|
||||
### 2. Architecture
|
||||
- **High-Level Structure**: System components and layers
|
||||
- **Design Patterns**: Patterns employed and why
|
||||
- **Data Flow**: How information moves through the system
|
||||
- **Control Flow**: Request/response cycles, event handling
|
||||
- **Diagrams**: Visual representations (Mermaid)
|
||||
- **Architectural Decisions**: ADRs or rationale
|
||||
|
||||
### 3. Directory Structure
|
||||
- **Organization**: Purpose of each directory
|
||||
- **Conventions**: File naming and organization patterns
|
||||
- **Entry Points**: Where execution begins
|
||||
- **Core Modules**: Most important files/directories
|
||||
- **Configuration**: Where settings live
|
||||
|
||||
### 4. Key Components
|
||||
- **Major Modules**: Primary code units
|
||||
- **Classes & Functions**: Important abstractions
|
||||
- **Responsibilities**: What each component does
|
||||
- **Interactions**: How components work together
|
||||
- **Extension Points**: Where to add new features
|
||||
- **Code Examples**: Typical usage patterns
|
||||
|
||||
### 5. External Integrations
|
||||
- **APIs Consumed**: Third-party services used
|
||||
- **Databases**: Data stores and schemas
|
||||
- **Authentication**: How auth works
|
||||
- **Caching**: Caching strategies
|
||||
- **Message Queues**: Async communication
|
||||
- **File Storage**: Where files are stored
|
||||
|
||||
### 6. Data Models
|
||||
- **Database Schema**: Tables, relationships
|
||||
- **Data Structures**: Key types and interfaces
|
||||
- **Validation**: How data is validated
|
||||
- **Migrations**: Schema evolution
|
||||
- **Data Flow**: How data transforms
|
||||
|
||||
### 7. Development Setup
|
||||
- **Prerequisites**: Required tools and versions
|
||||
- **Installation**: Step-by-step setup
|
||||
- **Configuration**: Environment variables, configs
|
||||
- **Running**: How to start the application
|
||||
- **Testing**: How to run tests
|
||||
- **Debugging**: Debugging strategies
|
||||
- **Common Issues**: Troubleshooting guide
|
||||
|
||||
### 8. Development Guidelines
|
||||
- **Coding Conventions**: Style and patterns
|
||||
- **Testing Approach**: Testing philosophy
|
||||
- **Error Handling**: How errors are handled
|
||||
- **Logging**: Logging practices
|
||||
- **Security Practices**: Security considerations
|
||||
- **Performance**: Performance patterns
|
||||
|
||||
### 9. Deployment
|
||||
- **Build Process**: How to build for production
|
||||
- **Deployment Steps**: How to deploy
|
||||
- **Environments**: Dev, staging, production
|
||||
- **Monitoring**: How the system is monitored
|
||||
- **Rollback**: How to undo deployments
|
||||
|
||||
### 10. Contributing
|
||||
- **Development Workflow**: Branch strategy, PR process
|
||||
- **Code Review**: Review guidelines
|
||||
- **Testing Requirements**: What tests are needed
|
||||
- **Documentation**: When/how to update docs
|
||||
|
||||
## Approach
|
||||
|
||||
### Analysis Strategy
|
||||
|
||||
1. **Explore thoroughly** using Explore agent
|
||||
2. **Map structure** with Glob to find key files
|
||||
3. **Read critical files** (README, main entry points, core modules)
|
||||
4. **Identify patterns** through Grep (imports, exports, patterns)
|
||||
5. **Understand data flow** by tracing execution paths
|
||||
6. **Extract knowledge** from existing docs, comments, tests
|
||||
7. **Synthesize** into cohesive documentation
|
||||
|
||||
### Documentation Output
|
||||
|
||||
Creates a comprehensive markdown document (or multiple docs):
|
||||
|
||||
```
|
||||
docs/
|
||||
├── README.md # Overview and quick start
|
||||
├── ARCHITECTURE.md # System architecture
|
||||
├── DEVELOPMENT.md # Development guide
|
||||
├── API.md # API documentation (if applicable)
|
||||
├── DEPLOYMENT.md # Deployment guide
|
||||
└── CONTRIBUTING.md # Contribution guidelines
|
||||
```
|
||||
|
||||
Or single comprehensive doc if preferred.
|
||||
|
||||
### Depth Levels
|
||||
|
||||
Adapts depth based on needs:
|
||||
- **Quick**: High-level overview (15-30 min)
|
||||
- **Standard**: Comprehensive coverage (30-60 min)
|
||||
- **Deep**: Exhaustive with examples (60+ min)
|
||||
|
||||
### Visual Elements
|
||||
|
||||
Includes:
|
||||
- **Mermaid diagrams**: Architecture, flow charts, sequence diagrams
|
||||
- **Code examples**: Real code from the codebase
|
||||
- **File references**: Specific file:line pointers
|
||||
- **Tables**: For structured information
|
||||
- **Lists**: For guidelines and conventions
|
||||
|
||||
## Example Interaction
|
||||
|
||||
```
|
||||
User: "Explain this codebase and create documentation"
|
||||
|
||||
Skill:
|
||||
1. Explores codebase structure
|
||||
2. Identifies:
|
||||
- Express.js REST API
|
||||
- PostgreSQL database
|
||||
- React frontend (separate repo)
|
||||
- Redis caching
|
||||
- JWT authentication
|
||||
3. Maps architecture:
|
||||
- routes/ → controllers/ → services/ → models/
|
||||
- middleware for auth, validation, logging
|
||||
- config/ for environment-specific settings
|
||||
4. Generates documentation:
|
||||
- Architecture diagram (Mermaid)
|
||||
- API endpoint reference
|
||||
- Database schema
|
||||
- Development setup guide
|
||||
- Contributing guidelines
|
||||
- Deployment process
|
||||
5. Creates docs/ directory with organized markdown files
|
||||
```
|
||||
|
||||
## Tools Used
|
||||
|
||||
- **Task (Explore agent)**: Comprehensive codebase exploration
|
||||
- **Glob**: Map directory structure and find files
|
||||
- **Grep**: Find patterns, imports, exports
|
||||
- **Read**: Analyze key files in detail
|
||||
- **Write**: Create documentation files
|
||||
- **Bash**: Extract metadata (git log, dependency versions)
|
||||
|
||||
## Success Criteria
|
||||
|
||||
- Complete coverage of all documentation areas
|
||||
- Clear explanations with examples
|
||||
- Visual diagrams for complex concepts
|
||||
- Specific file:line references throughout
|
||||
- Actionable setup/development instructions
|
||||
- New developer can onboard using only this doc
|
||||
- Organized, navigable structure
|
||||
- Accurate and up-to-date information
|
||||
|
||||
## Output Formats
|
||||
|
||||
Can generate:
|
||||
- **Markdown files**: Standard developer docs
|
||||
- **HTML**: For internal wikis or hosting
|
||||
- **PDF**: Using document-skills if requested
|
||||
- **Inline**: Single comprehensive response
|
||||
|
||||
User can specify format preference, defaults to markdown files.
|
||||
|
||||
## Customization
|
||||
|
||||
Adapts to:
|
||||
- **Audience**: New developers vs experienced team
|
||||
- **Depth**: Quick overview vs comprehensive guide
|
||||
- **Focus**: Architecture-focused vs development-focused
|
||||
- **Format**: Multiple files vs single doc
|
||||
|
||||
## Integration
|
||||
|
||||
Works well with:
|
||||
- **code-auditor**: Includes quality/security context in docs
|
||||
- **project-bootstrapper**: Documents bootstrap decisions
|
||||
- **visual-html-creator**: Create visual diagrams and flows
|
||||
|
||||
## Special Features
|
||||
|
||||
### Auto-Discovery
|
||||
|
||||
Automatically detects and documents:
|
||||
- **Framework conventions**: Rails, Django, Next.js patterns
|
||||
- **API patterns**: REST, GraphQL, gRPC
|
||||
- **Testing approaches**: Unit, integration, e2e
|
||||
- **Build systems**: Webpack, Vite, etc.
|
||||
- **Deployment targets**: Docker, serverless, etc.
|
||||
|
||||
### Living Documentation
|
||||
|
||||
Can suggest:
|
||||
- Where to add code comments for clarity
|
||||
- What should be documented in code vs external docs
|
||||
- How to keep documentation synchronized with code
|
||||
- Automation for doc generation (JSDoc, Sphinx, etc.)
|
||||
|
||||
## Post-Documentation
|
||||
|
||||
After generating docs, provides:
|
||||
- **Summary** of what was documented
|
||||
- **Gaps** that couldn't be fully documented (need clarification)
|
||||
- **Suggestions** for keeping docs current
|
||||
- **Next steps** for improving codebase clarity
|
||||
- **Templates** for future documentation
|
||||
|
||||
## Privacy & Security
|
||||
|
||||
- **Avoids** documenting sensitive information (secrets, keys)
|
||||
- **Redacts** credentials if found
|
||||
- **Flags** security issues for separate discussion
|
||||
- **Respects** .gitignore (doesn't document ignored files)
|
||||
@@ -0,0 +1,174 @@
|
||||
---
|
||||
name: conversation-analyzer
|
||||
description: Analyzes your Claude Code conversation history to identify patterns, common mistakes, and opportunities for workflow improvement. Use when user wants to understand usage patterns, optimize workflow, identify automation opportunities, or check if they're following best practices. Also activates when user says "analyze my conversations", "review my history", "how can I improve my workflow", or similar usage analysis requests.
|
||||
---
|
||||
|
||||
# Conversation Analyzer Skill
|
||||
|
||||
## Purpose
|
||||
|
||||
Analyzes your Claude Code conversation history to identify patterns, common mistakes, and opportunities for workflow improvement. Provides actionable recommendations for optimizing your development workflow.
|
||||
|
||||
## When to Use
|
||||
|
||||
This skill automatically activates when users want to:
|
||||
- Understand their Claude Code usage patterns
|
||||
- Identify repetitive tasks that could be automated
|
||||
- Optimize their workflow
|
||||
- Check if they're following best practices
|
||||
- Find opportunities for creating custom skills or slash commands
|
||||
|
||||
**Activation phrases:**
|
||||
- "analyze my conversations"
|
||||
- "review my Claude Code history"
|
||||
- "what patterns do you see in my usage"
|
||||
- "how can I improve my workflow"
|
||||
- "am I using Claude Code effectively"
|
||||
|
||||
## What It Does
|
||||
|
||||
1. **Loads conversation history** from `~/.claude/history.jsonl`
|
||||
2. **Analyzes patterns** including:
|
||||
- Request type distribution
|
||||
- Most active projects
|
||||
- Common error keywords
|
||||
- Time-of-day patterns
|
||||
- Repetitive tasks
|
||||
3. **Identifies issues** such as:
|
||||
- Vague requests that cause back-and-forth
|
||||
- Complex tasks attempted without planning
|
||||
- Repeated similar requests (automation opportunities)
|
||||
- Recurring bugs or errors
|
||||
4. **Generates recommendations** for:
|
||||
- Skills you should use more
|
||||
- Workflows to streamline
|
||||
- Custom skills or commands to create
|
||||
- Best practices to adopt
|
||||
|
||||
## Approach
|
||||
|
||||
### Analysis Scope
|
||||
|
||||
By default, analyzes the **last 200 conversations** for recency and relevance. Can be adjusted based on user preference.
|
||||
|
||||
### Methodology
|
||||
|
||||
The analysis examines:
|
||||
|
||||
1. **Request Type Distribution**
|
||||
- Categorizes by: bug fixes, feature additions, refactoring, information queries, testing, other
|
||||
- Identifies dominant request types
|
||||
|
||||
2. **Project Activity**
|
||||
- Tracks which projects consume most time
|
||||
- Identifies project-specific patterns
|
||||
- Suggests project-specific optimizations
|
||||
|
||||
3. **Time Patterns**
|
||||
- Hour-of-day usage distribution
|
||||
- Identifies peak productivity times
|
||||
|
||||
4. **Common Mistakes**
|
||||
- **Vague requests**: Initial requests lacking context vs. acceptable follow-ups
|
||||
- **Repeated fixes**: Same issues occurring multiple times
|
||||
- **Complex tasks**: Multi-step requests without planning
|
||||
- **Repetitive commands**: Manual tasks that could be automated
|
||||
|
||||
5. **Error Analysis**
|
||||
- Frequency of error-related requests
|
||||
- Common error keywords
|
||||
- Recurring problems
|
||||
|
||||
6. **Automation Opportunities**
|
||||
- Identifies repeated exact requests
|
||||
- Suggests skills, slash commands, or scripts
|
||||
|
||||
### Output Format
|
||||
|
||||
Provides a structured report with:
|
||||
- **Statistics**: Request types, active projects, timing patterns
|
||||
- **Patterns**: Common tasks, repetitive commands, complexity indicators
|
||||
- **Issues**: Specific problems identified with examples
|
||||
- **Recommendations**: Prioritized, actionable improvements
|
||||
|
||||
### Tools Used
|
||||
|
||||
- **Read**: Load history file (`~/.claude/history.jsonl`) and analysis scripts
|
||||
- **Write**: Create analysis reports if requested
|
||||
- **Bash**: Execute Python analysis script for comprehensive analysis
|
||||
- **Direct analysis**: Parse JSON and analyze programmatically for quick insights
|
||||
|
||||
### Analysis Implementation
|
||||
|
||||
The skill uses a Python script (`scripts/analyze_history.py`) for comprehensive analysis:
|
||||
|
||||
**Script capabilities:**
|
||||
- Loads and parses `~/.claude/history.jsonl`
|
||||
- Analyzes patterns across multiple dimensions
|
||||
- Identifies common mistakes and inefficiencies
|
||||
- Generates actionable recommendations
|
||||
- Outputs detailed reports
|
||||
|
||||
**How to use the script:**
|
||||
|
||||
1. **Within the skill (automatic):**
|
||||
```
|
||||
User: "Analyze my conversations"
|
||||
→ Skill runs the script automatically
|
||||
→ Presents findings in conversational format
|
||||
```
|
||||
|
||||
2. **Standalone (advanced users):**
|
||||
```bash
|
||||
cd ~/.claude/plugins/*/productivity-skills/conversation-analyzer/scripts
|
||||
python3 analyze_history.py
|
||||
```
|
||||
|
||||
Outputs:
|
||||
- `conversation_analysis.txt` - Detailed pattern analysis
|
||||
- `recommendations.txt` - Specific improvement suggestions
|
||||
|
||||
**Script location:** `productivity-skills-plugin/conversation-analyzer/scripts/analyze_history.py`
|
||||
|
||||
## Example Interaction
|
||||
|
||||
```
|
||||
User: "Analyze my recent conversations and tell me how to improve"
|
||||
|
||||
Skill:
|
||||
1. Loads ~/.claude/history.jsonl
|
||||
2. Runs analysis script (scripts/analyze_history.py)
|
||||
3. Analyzes last 200 conversations
|
||||
4. Identifies:
|
||||
- 60% general tasks, 15% bug fixes, 13% feature additions
|
||||
- Project "ultramerge" dominates 58% of activity
|
||||
- Same test-fixing request made 8 times
|
||||
- 19 multi-step requests without planning
|
||||
- Peak productivity: 13:00-15:00
|
||||
5. Recommends:
|
||||
- Use test-fixing skill for recurring test failures
|
||||
- Create project-specific utilities for ultramerge data processing
|
||||
- Use feature-planning skill for complex multi-step requests
|
||||
- Add tests to prevent recurring bugs
|
||||
- Schedule complex work during peak hours
|
||||
6. Provides specific examples from history to illustrate patterns
|
||||
```
|
||||
|
||||
## Success Criteria
|
||||
|
||||
- User understands their usage patterns
|
||||
- Concrete, actionable recommendations provided
|
||||
- Specific examples from their history
|
||||
- Prioritized by impact (quick wins vs long-term)
|
||||
- User can immediately apply improvements
|
||||
|
||||
## Integration
|
||||
|
||||
Works well with:
|
||||
- **feature-planning**: For implementing recommended improvements
|
||||
- **test-fixing**: For addressing recurring test failures identified
|
||||
- **git-pushing**: For committing workflow improvements
|
||||
|
||||
## Privacy Note
|
||||
|
||||
All analysis happens locally. Conversation history never leaves the user's machine.
|
||||
@@ -0,0 +1,375 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Analyze Claude Code conversation history to identify patterns and common mistakes.
|
||||
"""
|
||||
|
||||
import json
|
||||
import re
|
||||
from collections import Counter, defaultdict
|
||||
from datetime import datetime
|
||||
from pathlib import Path
|
||||
|
||||
def load_history(history_path):
|
||||
"""Load and parse history.jsonl file."""
|
||||
conversations = []
|
||||
with open(history_path, 'r') as f:
|
||||
for line in f:
|
||||
try:
|
||||
conversations.append(json.loads(line))
|
||||
except json.JSONDecodeError:
|
||||
continue
|
||||
return conversations
|
||||
|
||||
def extract_patterns(conversations):
|
||||
"""Extract patterns from conversations."""
|
||||
patterns = {
|
||||
'common_tasks': Counter(),
|
||||
'projects': Counter(),
|
||||
'error_keywords': Counter(),
|
||||
'request_types': Counter(),
|
||||
'time_distribution': defaultdict(int),
|
||||
'complexity_indicators': Counter(),
|
||||
}
|
||||
|
||||
error_keywords = ['error', 'fix', 'bug', 'issue', 'problem', 'fail', 'broken', 'wrong', 'incorrect', 'merge conflict']
|
||||
complexity_indicators = ['refactor', 'implement', 'add feature', 'create', 'build', 'migrate', 'optimize', 'analyze']
|
||||
|
||||
for conv in conversations:
|
||||
display = conv.get('display', '').lower()
|
||||
project = conv.get('project', '')
|
||||
|
||||
# Count projects
|
||||
if project:
|
||||
patterns['projects'][project] += 1
|
||||
|
||||
# Count error-related requests
|
||||
for keyword in error_keywords:
|
||||
if keyword in display:
|
||||
patterns['error_keywords'][keyword] += 1
|
||||
|
||||
# Count complexity indicators
|
||||
for indicator in complexity_indicators:
|
||||
if indicator in display:
|
||||
patterns['complexity_indicators'][indicator] += 1
|
||||
|
||||
# Categorize request types
|
||||
if any(kw in display for kw in ['fix', 'error', 'bug', 'issue', 'problem']):
|
||||
patterns['request_types']['bug_fix'] += 1
|
||||
elif any(kw in display for kw in ['add', 'create', 'implement', 'build', 'new']):
|
||||
patterns['request_types']['feature_addition'] += 1
|
||||
elif any(kw in display for kw in ['refactor', 'improve', 'optimize', 'clean']):
|
||||
patterns['request_types']['refactoring'] += 1
|
||||
elif any(kw in display for kw in ['explain', 'what', 'how', 'why', 'analyze', 'understand']):
|
||||
patterns['request_types']['information_query'] += 1
|
||||
elif any(kw in display for kw in ['test', 'run', 'build', 'deploy']):
|
||||
patterns['request_types']['testing_deployment'] += 1
|
||||
else:
|
||||
patterns['request_types']['other'] += 1
|
||||
|
||||
# Time distribution (hour of day)
|
||||
if 'timestamp' in conv:
|
||||
dt = datetime.fromtimestamp(conv['timestamp'] / 1000)
|
||||
hour = dt.hour
|
||||
patterns['time_distribution'][hour] += 1
|
||||
|
||||
# Track all tasks
|
||||
patterns['common_tasks'][display] += 1
|
||||
|
||||
return patterns
|
||||
|
||||
def identify_common_mistakes(conversations):
|
||||
"""Identify patterns that might indicate common mistakes."""
|
||||
mistakes = {
|
||||
'repeated_fixes': [],
|
||||
'merge_conflicts': [],
|
||||
'repeated_requests': [],
|
||||
'vague_requests': [],
|
||||
'multi_step_without_planning': [],
|
||||
}
|
||||
|
||||
# Track repeated similar requests
|
||||
task_groups = defaultdict(list)
|
||||
for i, conv in enumerate(conversations):
|
||||
display = conv.get('display', '')
|
||||
|
||||
# Group similar tasks
|
||||
normalized = re.sub(r'\d+', '#', display.lower())
|
||||
normalized = re.sub(r'[^\w\s]', '', normalized)
|
||||
task_groups[normalized].append((i, display, conv))
|
||||
|
||||
# Identify repeated fixes
|
||||
for task, occurrences in task_groups.items():
|
||||
if len(occurrences) > 2 and any(kw in task for kw in ['fix', 'error', 'bug']):
|
||||
mistakes['repeated_fixes'].append({
|
||||
'pattern': task,
|
||||
'count': len(occurrences),
|
||||
'examples': [occ[1] for occ in occurrences[:3]]
|
||||
})
|
||||
|
||||
# Identify merge conflicts
|
||||
for conv in conversations:
|
||||
display = conv.get('display', '')
|
||||
if 'merge conflict' in display.lower():
|
||||
mistakes['merge_conflicts'].append(display)
|
||||
|
||||
# Identify repeated requests (exact matches)
|
||||
for task, occurrences in task_groups.items():
|
||||
if len(occurrences) > 3:
|
||||
mistakes['repeated_requests'].append({
|
||||
'pattern': occurrences[0][1],
|
||||
'count': len(occurrences)
|
||||
})
|
||||
|
||||
# Identify vague requests (very short or unclear)
|
||||
vague_keywords = ['this', 'that', 'it', 'the thing', 'stuff']
|
||||
for conv in conversations:
|
||||
display = conv.get('display', '')
|
||||
if len(display.split()) < 4 or any(vk in display.lower() for vk in vague_keywords):
|
||||
if len(display) < 30:
|
||||
mistakes['vague_requests'].append(display)
|
||||
|
||||
# Identify complex multi-step requests
|
||||
multi_step_indicators = [' and ', ', ', 'then ', 'also ', 'plus ']
|
||||
for conv in conversations:
|
||||
display = conv.get('display', '')
|
||||
if sum(indicator in display.lower() for indicator in multi_step_indicators) >= 2:
|
||||
mistakes['multi_step_without_planning'].append(display)
|
||||
|
||||
return mistakes
|
||||
|
||||
def generate_report(patterns, mistakes):
|
||||
"""Generate a comprehensive analysis report."""
|
||||
report = []
|
||||
|
||||
report.append("=" * 80)
|
||||
report.append("CLAUDE CODE CONVERSATION ANALYSIS REPORT")
|
||||
report.append("=" * 80)
|
||||
report.append("")
|
||||
|
||||
# Overall statistics
|
||||
report.append("## OVERALL STATISTICS")
|
||||
report.append(f"Total conversations: {sum(patterns['request_types'].values())}")
|
||||
report.append("")
|
||||
|
||||
# Request type distribution
|
||||
report.append("## REQUEST TYPE DISTRIBUTION")
|
||||
for req_type, count in patterns['request_types'].most_common():
|
||||
percentage = (count / sum(patterns['request_types'].values())) * 100
|
||||
report.append(f" {req_type.replace('_', ' ').title()}: {count} ({percentage:.1f}%)")
|
||||
report.append("")
|
||||
|
||||
# Most active projects
|
||||
report.append("## MOST ACTIVE PROJECTS")
|
||||
for project, count in patterns['projects'].most_common(10):
|
||||
report.append(f" {count:3d}x {project}")
|
||||
report.append("")
|
||||
|
||||
# Common error keywords
|
||||
report.append("## COMMON ERROR KEYWORDS")
|
||||
for keyword, count in patterns['error_keywords'].most_common(10):
|
||||
report.append(f" {keyword}: {count}")
|
||||
report.append("")
|
||||
|
||||
# Complexity indicators
|
||||
report.append("## COMPLEXITY INDICATORS")
|
||||
for indicator, count in patterns['complexity_indicators'].most_common(10):
|
||||
report.append(f" {indicator}: {count}")
|
||||
report.append("")
|
||||
|
||||
# Time distribution
|
||||
report.append("## TIME DISTRIBUTION (BY HOUR)")
|
||||
for hour in sorted(patterns['time_distribution'].keys()):
|
||||
count = patterns['time_distribution'][hour]
|
||||
bar = '█' * (count // 5)
|
||||
report.append(f" {hour:02d}:00 {bar} ({count})")
|
||||
report.append("")
|
||||
|
||||
# Common mistakes
|
||||
report.append("=" * 80)
|
||||
report.append("## IDENTIFIED COMMON MISTAKES AND PATTERNS")
|
||||
report.append("=" * 80)
|
||||
report.append("")
|
||||
|
||||
if mistakes['merge_conflicts']:
|
||||
report.append(f"### 1. MERGE CONFLICTS ({len(mistakes['merge_conflicts'])} occurrences)")
|
||||
report.append("These indicate potential git workflow issues:")
|
||||
for mc in mistakes['merge_conflicts'][:5]:
|
||||
report.append(f" - {mc}")
|
||||
report.append("")
|
||||
|
||||
if mistakes['repeated_fixes']:
|
||||
report.append(f"### 2. REPEATED FIX PATTERNS ({len(mistakes['repeated_fixes'])} patterns)")
|
||||
report.append("Similar fixes requested multiple times - may indicate recurring issues:")
|
||||
for fix in sorted(mistakes['repeated_fixes'], key=lambda x: x['count'], reverse=True)[:5]:
|
||||
report.append(f" - Pattern: '{fix['pattern']}' (occurred {fix['count']} times)")
|
||||
for example in fix['examples'][:2]:
|
||||
report.append(f" Example: {example}")
|
||||
report.append("")
|
||||
|
||||
if mistakes['repeated_requests']:
|
||||
report.append(f"### 3. REPEATED EXACT REQUESTS ({len(mistakes['repeated_requests'])} patterns)")
|
||||
report.append("Exact same requests multiple times - could be automated:")
|
||||
for req in sorted(mistakes['repeated_requests'], key=lambda x: x['count'], reverse=True)[:5]:
|
||||
report.append(f" - '{req['pattern']}' (x{req['count']})")
|
||||
report.append("")
|
||||
|
||||
if mistakes['vague_requests']:
|
||||
report.append(f"### 4. VAGUE REQUESTS ({len(mistakes['vague_requests'])} found)")
|
||||
report.append("Short or unclear requests that might benefit from more context:")
|
||||
for vague in mistakes['vague_requests'][:10]:
|
||||
report.append(f" - '{vague}'")
|
||||
report.append("")
|
||||
|
||||
if mistakes['multi_step_without_planning']:
|
||||
report.append(f"### 5. COMPLEX MULTI-STEP REQUESTS ({len(mistakes['multi_step_without_planning'])} found)")
|
||||
report.append("Requests with multiple steps that could benefit from planning:")
|
||||
for multi in mistakes['multi_step_without_planning'][:10]:
|
||||
report.append(f" - {multi}")
|
||||
report.append("")
|
||||
|
||||
# Most common tasks
|
||||
report.append("## TOP 20 MOST COMMON TASKS")
|
||||
for task, count in patterns['common_tasks'].most_common(20):
|
||||
if count > 1:
|
||||
report.append(f" {count:3d}x {task}")
|
||||
report.append("")
|
||||
|
||||
return "\n".join(report)
|
||||
|
||||
def generate_recommendations(patterns, mistakes):
|
||||
"""Generate specific recommendations based on analysis."""
|
||||
recommendations = []
|
||||
|
||||
recommendations.append("=" * 80)
|
||||
recommendations.append("RECOMMENDATIONS FOR IMPROVEMENT")
|
||||
recommendations.append("=" * 80)
|
||||
recommendations.append("")
|
||||
|
||||
rec_num = 1
|
||||
|
||||
# Merge conflict recommendations
|
||||
if mistakes['merge_conflicts']:
|
||||
recommendations.append(f"{rec_num}. GIT WORKFLOW IMPROVEMENTS")
|
||||
recommendations.append(" Problem: Multiple merge conflicts detected")
|
||||
recommendations.append(" Solutions:")
|
||||
recommendations.append(" - Create a pre-commit hook to check for conflicts")
|
||||
recommendations.append(" - Add a git alias for safe rebasing")
|
||||
recommendations.append(" - Document merge conflict resolution workflow")
|
||||
recommendations.append(" - Consider using git hooks to prevent pushing conflicted files")
|
||||
recommendations.append("")
|
||||
rec_num += 1
|
||||
|
||||
# Repeated fixes recommendations
|
||||
if mistakes['repeated_fixes']:
|
||||
recommendations.append(f"{rec_num}. PREVENT RECURRING BUGS")
|
||||
recommendations.append(" Problem: Same types of fixes requested repeatedly")
|
||||
recommendations.append(" Solutions:")
|
||||
recommendations.append(" - Add linting rules to catch common errors")
|
||||
recommendations.append(" - Create test cases for frequently fixed bugs")
|
||||
recommendations.append(" - Document common pitfalls in CLAUDE.md")
|
||||
recommendations.append(" - Consider pre-commit hooks for validation")
|
||||
recommendations.append("")
|
||||
rec_num += 1
|
||||
|
||||
# Repeated requests
|
||||
if mistakes['repeated_requests']:
|
||||
recommendations.append(f"{rec_num}. AUTOMATE REPETITIVE TASKS")
|
||||
recommendations.append(" Problem: Same requests made multiple times")
|
||||
recommendations.append(" Solutions:")
|
||||
recommendations.append(" - Create slash commands for common tasks")
|
||||
recommendations.append(" - Add shell aliases or scripts")
|
||||
recommendations.append(" - Consider creating Claude Code skills for workflows")
|
||||
recommendations.append(" - Document common patterns in CLAUDE.md")
|
||||
recommendations.append("")
|
||||
rec_num += 1
|
||||
|
||||
# Vague requests
|
||||
if mistakes['vague_requests']:
|
||||
recommendations.append(f"{rec_num}. IMPROVE REQUEST CLARITY")
|
||||
recommendations.append(" Problem: Many vague or unclear requests")
|
||||
recommendations.append(" Solutions:")
|
||||
recommendations.append(" - Create request templates in CLAUDE.md")
|
||||
recommendations.append(" - Add examples of good vs. bad requests")
|
||||
recommendations.append(" - Use more specific language and context")
|
||||
recommendations.append(" - Break down complex requests into steps")
|
||||
recommendations.append("")
|
||||
rec_num += 1
|
||||
|
||||
# Multi-step planning
|
||||
if mistakes['multi_step_without_planning']:
|
||||
recommendations.append(f"{rec_num}. BETTER TASK PLANNING")
|
||||
recommendations.append(" Problem: Complex multi-step requests without planning")
|
||||
recommendations.append(" Solutions:")
|
||||
recommendations.append(" - Use 'plan mode' for complex tasks")
|
||||
recommendations.append(" - Break down requests into discrete steps")
|
||||
recommendations.append(" - Create checklists for common workflows")
|
||||
recommendations.append(" - Consider using the feature-planning skill")
|
||||
recommendations.append("")
|
||||
rec_num += 1
|
||||
|
||||
# Error-heavy workflow
|
||||
error_ratio = sum(patterns['error_keywords'].values()) / max(sum(patterns['request_types'].values()), 1)
|
||||
if error_ratio > 0.3:
|
||||
recommendations.append(f"{rec_num}. REDUCE ERROR RATE")
|
||||
recommendations.append(f" Problem: High error rate detected ({error_ratio*100:.1f}% of requests)")
|
||||
recommendations.append(" Solutions:")
|
||||
recommendations.append(" - Implement comprehensive testing before changes")
|
||||
recommendations.append(" - Add validation hooks (pre-commit, pre-push)")
|
||||
recommendations.append(" - Create a testing checklist in CLAUDE.md")
|
||||
recommendations.append(" - Consider TDD approach for new features")
|
||||
recommendations.append("")
|
||||
rec_num += 1
|
||||
|
||||
return "\n".join(recommendations)
|
||||
|
||||
def main():
|
||||
history_path = Path.home() / '.claude' / 'history.jsonl'
|
||||
|
||||
print("Loading conversation history...")
|
||||
all_conversations = load_history(history_path)
|
||||
|
||||
# Focus on recent conversations (last 200)
|
||||
recent_conversations = all_conversations[-200:]
|
||||
|
||||
print(f"Analyzing {len(all_conversations)} total conversations...")
|
||||
print(f"Deep analysis on {len(recent_conversations)} recent conversations...")
|
||||
|
||||
patterns = extract_patterns(recent_conversations)
|
||||
mistakes = identify_common_mistakes(recent_conversations)
|
||||
|
||||
print("\nGenerating reports...")
|
||||
report = generate_report(patterns, mistakes)
|
||||
recommendations = generate_recommendations(patterns, mistakes)
|
||||
|
||||
# Save reports
|
||||
output_dir = Path.cwd()
|
||||
|
||||
# Add header with analysis scope
|
||||
header = f"""
|
||||
ANALYSIS SCOPE
|
||||
==============
|
||||
Total conversations in history: {len(all_conversations)}
|
||||
Recent conversations analyzed: {len(recent_conversations)}
|
||||
Time period: Last 200 interactions
|
||||
|
||||
"""
|
||||
|
||||
with open(output_dir / 'conversation_analysis.txt', 'w') as f:
|
||||
f.write(header)
|
||||
f.write(report)
|
||||
|
||||
with open(output_dir / 'recommendations.txt', 'w') as f:
|
||||
f.write(recommendations)
|
||||
|
||||
print("\n" + "=" * 80)
|
||||
print("Analysis complete! Reports saved to:")
|
||||
print(f" - {output_dir / 'conversation_analysis.txt'}")
|
||||
print(f" - {output_dir / 'recommendations.txt'}")
|
||||
print("=" * 80)
|
||||
|
||||
# Print summary to console
|
||||
print("\n" + report)
|
||||
print("\n" + recommendations)
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@@ -0,0 +1,221 @@
|
||||
---
|
||||
name: project-bootstrapper
|
||||
description: Sets up new projects or improves existing projects with development best practices, tooling, documentation, and workflow automation. Use when user wants to start a new project, improve project structure, add development tooling, or establish professional workflows. Also activates when user says "set up a new project", "bootstrap this project", "add best practices", "improve project structure", or similar setup requests.
|
||||
---
|
||||
|
||||
# Project Bootstrapper Skill
|
||||
|
||||
## Purpose
|
||||
|
||||
Sets up new projects or improves existing projects with development best practices, tooling, documentation, and workflow automation. Creates a professional, maintainable foundation for development.
|
||||
|
||||
## When to Use
|
||||
|
||||
This skill automatically activates when users want to:
|
||||
- Start a new project from scratch
|
||||
- Improve existing project structure
|
||||
- Add missing development tooling
|
||||
- Standardize project setup
|
||||
- Set up CI/CD pipelines
|
||||
- Create professional documentation
|
||||
- Establish development workflows
|
||||
|
||||
**Activation phrases:**
|
||||
- "set up a new project"
|
||||
- "bootstrap this project"
|
||||
- "add best practices"
|
||||
- "improve project structure"
|
||||
- "set up development tooling"
|
||||
- "initialize project properly"
|
||||
- "create project foundation"
|
||||
|
||||
## What It Does
|
||||
|
||||
Systematically sets up or improves a project across eight key areas:
|
||||
|
||||
### 1. Project Structure
|
||||
- Analyzes existing structure (if any)
|
||||
- Creates standard directories:
|
||||
- `src/` or language-specific source dirs
|
||||
- `tests/` or `__tests__/`
|
||||
- `docs/` for documentation
|
||||
- `scripts/` for automation
|
||||
- `.github/` for GitHub workflows (if applicable)
|
||||
- Organizes files logically
|
||||
- Suggests structure improvements
|
||||
|
||||
### 2. Git Configuration
|
||||
- Creates/updates `.gitignore` with comprehensive patterns
|
||||
- Sets up `.gitattributes` for line endings and diffs
|
||||
- Configures git hooks (pre-commit, commit-msg, etc.)
|
||||
- Adds branch protection patterns
|
||||
- Sets up git LFS if needed
|
||||
|
||||
### 3. Documentation
|
||||
- Creates comprehensive `README.md`:
|
||||
- Project description and purpose
|
||||
- Installation instructions
|
||||
- Usage examples
|
||||
- Development setup
|
||||
- Contributing guidelines
|
||||
- License information
|
||||
- Adds `CONTRIBUTING.md` for collaboration
|
||||
- Sets up code documentation (JSDoc, docstrings, etc.)
|
||||
- Creates `CHANGELOG.md` structure
|
||||
- Adds architecture documentation if complex
|
||||
|
||||
### 4. Testing Setup
|
||||
- Identifies or suggests testing framework
|
||||
- Sets up test structure and conventions
|
||||
- Creates example/template tests
|
||||
- Configures test runners
|
||||
- Sets up coverage reporting
|
||||
- Adds testing scripts/commands
|
||||
|
||||
### 5. Code Quality Tools
|
||||
- Configures linters (ESLint, Pylint, etc.)
|
||||
- Sets up code formatters (Prettier, Black, etc.)
|
||||
- Adds type checking (TypeScript, mypy, etc.)
|
||||
- Configures pre-commit hooks for quality
|
||||
- Sets up editor configs (.editorconfig)
|
||||
- Adds code quality badges
|
||||
|
||||
### 6. Dependencies Management
|
||||
- Sets up package manager configuration
|
||||
- Organizes dependencies logically
|
||||
- Checks for security vulnerabilities
|
||||
- Sets up dependency updates (Dependabot, Renovate)
|
||||
- Creates lock files
|
||||
- Documents dependency choices
|
||||
|
||||
### 7. Development Workflow
|
||||
- Creates useful npm scripts / Makefile targets
|
||||
- Sets up environment variable templates (.env.example)
|
||||
- Adds Docker configuration if appropriate
|
||||
- Creates development startup scripts
|
||||
- Sets up hot-reload / watch modes
|
||||
- Documents development workflow
|
||||
|
||||
### 8. CI/CD Setup
|
||||
- Creates GitHub Actions / GitLab CI config
|
||||
- Sets up automated testing
|
||||
- Configures automated deployment (if applicable)
|
||||
- Adds status badges
|
||||
- Sets up release automation
|
||||
- Configures branch protection
|
||||
|
||||
## Approach
|
||||
|
||||
### Discovery Phase
|
||||
|
||||
Before making changes, asks clarifying questions:
|
||||
|
||||
1. **Project type**: New or existing?
|
||||
2. **Primary purpose**: Web app, library, CLI tool, etc.?
|
||||
3. **Language/framework**: JavaScript/TypeScript, Python, Go, etc.?
|
||||
4. **Collaboration**: Personal or team project?
|
||||
5. **Deployment target**: Server, cloud, mobile, desktop?
|
||||
6. **Preferences**: Specific tools or frameworks preferred?
|
||||
7. **Scope**: Full setup or specific areas?
|
||||
|
||||
### Implementation Phase
|
||||
|
||||
1. **Analyze existing** structure (if existing project)
|
||||
2. **Create plan** based on user answers
|
||||
3. **Show plan** and get approval
|
||||
4. **Implement systematically**:
|
||||
- One area at a time
|
||||
- Explain each change
|
||||
- Test as you go
|
||||
5. **Verify completeness**
|
||||
6. **Provide handoff** documentation
|
||||
|
||||
### Customization
|
||||
|
||||
Adapts to:
|
||||
- **Language ecosystem**: Node.js vs Python vs Go vs Rust, etc.
|
||||
- **Project size**: Small script vs large application
|
||||
- **Team size**: Solo vs collaborative
|
||||
- **Maturity**: Startup speed vs enterprise standards
|
||||
|
||||
## Example Interaction
|
||||
|
||||
```
|
||||
User: "Set up this new Python project properly"
|
||||
|
||||
Skill:
|
||||
Asks:
|
||||
- Purpose? → "CLI tool for data processing"
|
||||
- Deployment? → "PyPI package"
|
||||
- Preferences? → "Use Poetry for deps, pytest for tests"
|
||||
|
||||
Implements:
|
||||
1. Project structure (src/package_name, tests/, docs/)
|
||||
2. Poetry configuration with pyproject.toml
|
||||
3. Git setup (.gitignore for Python, pre-commit hooks)
|
||||
4. README with installation and usage
|
||||
5. Pytest setup with example tests
|
||||
6. Black + Ruff for formatting/linting
|
||||
7. GitHub Actions for CI
|
||||
8. Makefile with common commands
|
||||
|
||||
Result: Professional, ready-to-develop project
|
||||
```
|
||||
|
||||
## Tools Used
|
||||
|
||||
- **AskUserQuestion**: Gather requirements and preferences
|
||||
- **Write**: Create configuration files, documentation
|
||||
- **Edit**: Update existing files
|
||||
- **Bash**: Initialize tools (git init, npm init, etc.)
|
||||
- **Read**: Analyze existing project structure
|
||||
- **Glob**: Find files to update or migrate
|
||||
|
||||
## Success Criteria
|
||||
|
||||
- All standard files present and configured
|
||||
- Documentation is clear and complete
|
||||
- Development workflow is documented
|
||||
- Quality tooling is automated (pre-commit hooks)
|
||||
- Tests can be run easily
|
||||
- Project follows language/framework conventions
|
||||
- New developers can onboard quickly
|
||||
- No obvious best practices missing
|
||||
|
||||
## Templates
|
||||
|
||||
Maintains templates for common setups:
|
||||
- **Node.js/TypeScript web app**
|
||||
- **Python CLI tool**
|
||||
- **Python web API (FastAPI/Flask)**
|
||||
- **React/Next.js app**
|
||||
- **Go service**
|
||||
- **Rust CLI/library**
|
||||
|
||||
Uses appropriate template as starting point, customizes based on user needs.
|
||||
|
||||
## Integration
|
||||
|
||||
Works well with:
|
||||
- **feature-planning**: For planning custom project features
|
||||
- **code-auditor**: For validating setup quality
|
||||
- **codebase-documenter**: For generating detailed docs
|
||||
|
||||
## Scope Control
|
||||
|
||||
Can do:
|
||||
- **Full bootstrap**: Everything from scratch
|
||||
- **Partial setup**: Specific areas only (e.g., "just add testing")
|
||||
- **Improvement pass**: Enhance existing project
|
||||
- **Audit + fix**: Check what's missing and add it
|
||||
|
||||
User can specify scope, defaults to full setup for new projects, improvement pass for existing.
|
||||
|
||||
## Post-Setup
|
||||
|
||||
After setup, provides:
|
||||
- **Checklist** of what was done
|
||||
- **Next steps** for starting development
|
||||
- **Tips** specific to the stack
|
||||
- **Commands reference** for common tasks
|
||||
- **Customization guide** for adapting the setup
|
||||
@@ -1,119 +0,0 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to the Visual Documentation Plugin will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [1.0.0] - 2025-01-20
|
||||
|
||||
### Added
|
||||
- Initial release of Visual Documentation Plugin
|
||||
- Four focused skills for creating visual HTML documentation:
|
||||
- `flowchart-creator` - Process flow diagrams and decision trees
|
||||
- `dashboard-creator` - KPI dashboards and data visualizations
|
||||
- `technical-doc-creator` - API docs and system architecture
|
||||
- `timeline-creator` - Project timelines and Gantt charts
|
||||
- Shared resource library with:
|
||||
- Process flow diagrams with decision trees
|
||||
- Metric dashboards with KPI cards and charts
|
||||
- Technical documentation with code blocks
|
||||
- Project timelines and roadmaps
|
||||
- Complete design system with:
|
||||
- Modern purple/blue gradient theme
|
||||
- Semantic color palette (success, warning, error, info)
|
||||
- Responsive mobile-first layout
|
||||
- WCAG AA accessibility compliance
|
||||
- Bundled templates:
|
||||
- `base_template.html` - Complete CSS framework
|
||||
- `flowchart_components.html` - Process flow patterns
|
||||
- `dashboard_components.html` - Chart and metric patterns
|
||||
- `timeline_components.html` - Timeline and Gantt patterns
|
||||
- Comprehensive references:
|
||||
- `design_patterns.md` - Full design system documentation
|
||||
- `svg_library.md` - SVG component library with examples
|
||||
- Plugin documentation:
|
||||
- README.md with examples and use cases
|
||||
- SETUP.md with installation and configuration
|
||||
- CHANGELOG.md (this file)
|
||||
|
||||
### Features
|
||||
- Self-contained HTML output (no external dependencies)
|
||||
- Embedded CSS and SVG graphics
|
||||
- Responsive design (desktop and mobile)
|
||||
- Professional gradient backgrounds
|
||||
- Color-coded semantic states
|
||||
- Arrow markers and connectors for flowcharts
|
||||
- Metric cards with large numbers and labels
|
||||
- Bar charts, pie charts, and line graphs
|
||||
- Horizontal and vertical timelines
|
||||
- Gantt chart components
|
||||
- Code syntax highlighting
|
||||
- Example boxes and legends
|
||||
- Browser compatibility (Chrome, Firefox, Safari, Edge)
|
||||
|
||||
### Design System
|
||||
- 6 semantic color categories with light/dark variants
|
||||
- Typography scale from 0.85em to 2.5em
|
||||
- Spacing system (10px to 60px)
|
||||
- Border radius patterns (5px to 20px)
|
||||
- Shadow depths (subtle to elevated)
|
||||
- Gradient effects and text styling
|
||||
- SVG text styling and positioning
|
||||
- Responsive breakpoints (768px, 1024px, 1440px)
|
||||
|
||||
### Templates
|
||||
- 250+ lines of reusable SVG components
|
||||
- Flowchart shapes (rectangles, circles, diamonds, hexagons)
|
||||
- Arrow markers (standard, success, error, warning)
|
||||
- Decision trees with branching logic
|
||||
- Status boxes (success, error, warning, in-progress)
|
||||
- Swimlane layouts for multi-track processes
|
||||
- Dashboard metric cards (4 gradient styles)
|
||||
- Bar charts with axes and labels
|
||||
- Horizontal progress bars
|
||||
- Pie/donut chart segments
|
||||
- Line charts with data points
|
||||
- Gauge/radial progress indicators
|
||||
- Timeline components (horizontal, vertical, Gantt, roadmap)
|
||||
- Milestone markers with status indicators
|
||||
|
||||
### Documentation
|
||||
- 458 lines of design system reference
|
||||
- 500+ lines of SVG component library
|
||||
- Step-by-step workflow guide
|
||||
- Best practices for readability and accessibility
|
||||
- Troubleshooting section
|
||||
- Example outputs for each visualization type
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
### Planned Features
|
||||
- Interactive elements (hover effects, tooltips)
|
||||
- Animation support (fade-in, transitions)
|
||||
- Dark mode variant
|
||||
- Additional color themes
|
||||
- Export to PDF functionality
|
||||
- Print-optimized styling
|
||||
- More chart types (scatter, radar, sankey)
|
||||
- Custom icon library
|
||||
- Markdown-to-visual-HTML converter
|
||||
|
||||
### Under Consideration
|
||||
- Integration with other plugins
|
||||
- Template customization UI
|
||||
- Style presets for different industries
|
||||
- Multi-language support
|
||||
- Collaborative editing features
|
||||
|
||||
---
|
||||
|
||||
## Version History
|
||||
|
||||
- **1.0.0** (2025-01-20) - Initial release
|
||||
|
||||
## Support
|
||||
|
||||
For issues, feature requests, or questions:
|
||||
- [Open an issue](https://github.com/mhattingpete/claude-skills-marketplace/issues)
|
||||
- [Claude Code Documentation](https://docs.claude.com/en/docs/claude-code/skills)
|
||||
@@ -1,43 +0,0 @@
|
||||
Visual Documentation Plugin - Complete Structure
|
||||
================================================
|
||||
|
||||
visual-documentation-plugin/
|
||||
├── .claude-plugin/
|
||||
│ └── plugin.json # Plugin manifest (metadata)
|
||||
│
|
||||
├── skills/
|
||||
│ └── visual-html-creator/
|
||||
│ ├── SKILL.md # Main skill instructions (458 lines)
|
||||
│ │
|
||||
│ ├── assets/
|
||||
│ │ └── templates/
|
||||
│ │ ├── base_template.html # Complete CSS framework (220 lines)
|
||||
│ │ ├── flowchart_components.html # Process flow patterns (250 lines)
|
||||
│ │ ├── dashboard_components.html # Charts & metrics (240 lines)
|
||||
│ │ └── timeline_components.html # Timelines & roadmaps (380 lines)
|
||||
│ │
|
||||
│ └── references/
|
||||
│ ├── design_patterns.md # Design system (500 lines)
|
||||
│ └── svg_library.md # SVG components (650 lines)
|
||||
│
|
||||
├── CHANGELOG.md # Version history
|
||||
├── README.md # Plugin documentation
|
||||
├── SETUP.md # Installation guide
|
||||
└── FILE_STRUCTURE.txt # This file
|
||||
|
||||
Total Lines of Documentation: ~2,700+
|
||||
Total Files: 11
|
||||
|
||||
Key Features:
|
||||
- 4 template files with reusable HTML/SVG components
|
||||
- 2 comprehensive reference documents
|
||||
- Complete design system with colors, typography, spacing
|
||||
- Responsive mobile-first layouts
|
||||
- WCAG AA accessibility compliance
|
||||
- Self-contained HTML output (no external dependencies)
|
||||
|
||||
Visualization Types Supported:
|
||||
1. Process Flow Diagrams (decision trees, flowcharts)
|
||||
2. Metric Dashboards (KPIs, charts, statistics)
|
||||
3. Technical Documentation (code blocks, API docs)
|
||||
4. Project Timelines (Gantt charts, roadmaps, milestones)
|
||||
@@ -1,253 +1,89 @@
|
||||
# Visual Documentation Plugin
|
||||
|
||||
Create stunning, professional visual HTML documentation with modern UI design, SVG diagrams, flowcharts, dashboards, and timelines.
|
||||
Create stunning visual HTML documentation with modern UI design, SVG diagrams, and interactive visualizations.
|
||||
|
||||
## Skills Included
|
||||
|
||||
### `flowchart-creator`
|
||||
|
||||
Create stunning HTML flowcharts and process flow diagrams with decision trees, color-coded stages, arrows, and swimlanes.
|
||||
|
||||
**Activates when:** User requests flowcharts, process diagrams, workflow visualizations, or decision trees.
|
||||
|
||||
**Example usage:**
|
||||
- "Create a flowchart for our order processing"
|
||||
- "Generate a process flow diagram showing deployment steps"
|
||||
- "Make a decision tree for our approval workflow"
|
||||
|
||||
### `dashboard-creator`
|
||||
|
||||
Create professional HTML dashboards with KPI metric cards, charts, progress indicators, and data visualizations.
|
||||
|
||||
**Activates when:** User requests dashboards, metrics displays, KPI visualizations, or data charts.
|
||||
|
||||
**Example usage:**
|
||||
- "Create a dashboard showing website analytics"
|
||||
- "Make a KPI dashboard for our sales metrics"
|
||||
- "Generate a performance dashboard with charts"
|
||||
|
||||
### `technical-doc-creator`
|
||||
|
||||
Create comprehensive HTML technical documentation with code blocks, API workflows, system architecture diagrams, and syntax highlighting.
|
||||
|
||||
**Activates when:** User requests technical documentation, API docs, code examples, or system architecture visualizations.
|
||||
|
||||
**Example usage:**
|
||||
- "Create API documentation for our user endpoints"
|
||||
- "Generate technical docs for our authentication system"
|
||||
- "Document our microservices architecture"
|
||||
|
||||
### `timeline-creator`
|
||||
|
||||
Create beautiful HTML timelines and project roadmaps with Gantt charts, milestones, phase groupings, and progress indicators.
|
||||
|
||||
**Activates when:** User requests timelines, roadmaps, Gantt charts, project schedules, or milestone visualizations.
|
||||
|
||||
**Example usage:**
|
||||
- "Create a timeline for our product launch"
|
||||
- "Generate a roadmap showing Q1-Q4 milestones"
|
||||
- "Make a Gantt chart for our project schedule"
|
||||
|
||||
**Design Features:**
|
||||
- Modern gradient backgrounds and color schemes
|
||||
- Semantic color system (success/warning/error/info)
|
||||
- Responsive mobile-first design
|
||||
- WCAG AA accessibility compliance
|
||||
- Self-contained HTML (no external dependencies)
|
||||
|
||||
## Installation
|
||||
|
||||
### From Marketplace
|
||||
|
||||
```bash
|
||||
# In Claude Code
|
||||
/plugin marketplace add mhattingpete/claude-skills-marketplace/visual-documentation-plugin
|
||||
```
|
||||
|
||||
### Manual Installation
|
||||
|
||||
1. Copy the `visual-documentation-plugin` directory to your Claude plugins folder
|
||||
2. Reload Claude Code
|
||||
|
||||
## Quick Start
|
||||
|
||||
Once installed, simply ask Claude to create visual documentation:
|
||||
|
||||
```
|
||||
"Create a visual HTML showing our deployment pipeline with these stages:
|
||||
- Development (commit to main)
|
||||
- Build (automated tests)
|
||||
- Staging deployment
|
||||
- Production deployment"
|
||||
```
|
||||
|
||||
Claude will generate a complete, standalone HTML file with:
|
||||
- Professional gradient design
|
||||
- SVG flowchart diagram
|
||||
- Color-coded process stages
|
||||
- Responsive layout
|
||||
- All styling embedded
|
||||
|
||||
## Example Outputs
|
||||
|
||||
### Process Flow Example
|
||||
**Request:** "Create a visual guide for our deployment process"
|
||||
|
||||
**Generates:**
|
||||
- Decision tree showing deployment paths (prod/staging/dev)
|
||||
- Status indicators for each stage
|
||||
- Color-coded boxes for different deployment types
|
||||
- Arrow flow showing sequential and parallel steps
|
||||
- Legend explaining status colors
|
||||
|
||||
### Dashboard Example
|
||||
**Request:** "Make a dashboard showing project metrics"
|
||||
|
||||
**Generates:**
|
||||
- Metric cards: total tasks, completed, in progress, blocked
|
||||
- Bar chart showing task distribution by category
|
||||
- Timeline visualization of milestone completion
|
||||
- Color-coded status indicators
|
||||
- Summary statistics in footer
|
||||
|
||||
### API Workflow Example
|
||||
**Request:** "Create visual HTML showing our API workflow"
|
||||
|
||||
**Generates:**
|
||||
- Sequential flow: Client → API Gateway → Services → Database
|
||||
- Request/response boxes with sample JSON
|
||||
- Authentication flow decision tree
|
||||
- Error handling paths
|
||||
- Code examples with syntax highlighting
|
||||
|
||||
### Timeline Example
|
||||
**Request:** "Build a timeline for our product roadmap"
|
||||
|
||||
**Generates:**
|
||||
- Horizontal timeline with quarters marked
|
||||
- Milestone markers with descriptions
|
||||
- Phase groupings (Planning, Development, Testing, Launch)
|
||||
- Dependency arrows between related items
|
||||
- Color-coded priorities
|
||||
|
||||
## Bundled Resources
|
||||
|
||||
### Templates (`assets/templates/`)
|
||||
- `base_template.html` - Complete CSS framework and document structure
|
||||
- `flowchart_components.html` - Process flow and decision tree patterns
|
||||
- `dashboard_components.html` - Metric cards, charts, and visualizations
|
||||
- `timeline_components.html` - Timeline and roadmap layouts
|
||||
|
||||
### References (`references/`)
|
||||
- `design_patterns.md` - Complete design system with colors, typography, spacing
|
||||
- `svg_library.md` - Comprehensive SVG component library with shapes and patterns
|
||||
|
||||
## Design System
|
||||
|
||||
### Color Palette
|
||||
|
||||
**Semantic Colors:**
|
||||
- Success/Confirmed: `#48bb78` (green)
|
||||
- Warning/Uncertain: `#f59e0b` (amber)
|
||||
- Info/Primary: `#4299e1` (blue)
|
||||
- Error/Critical: `#f56565` (red)
|
||||
- Process/Action: `#ed8936` (orange)
|
||||
- Special/Highlight: `#9f7aea` (purple)
|
||||
|
||||
**Primary Gradient:**
|
||||
```css
|
||||
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
|
||||
```
|
||||
|
||||
### Typography
|
||||
- Font: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif
|
||||
- Headings: 2.5em (h1), 1.8em (h2), 1.4em (h3)
|
||||
- Code: 'Courier New', monospace
|
||||
|
||||
### Responsive Design
|
||||
- Max container width: 1400px
|
||||
- Desktop padding: 40px
|
||||
- Mobile padding: 20px
|
||||
- Breakpoint: 768px
|
||||
|
||||
## Technical Details
|
||||
|
||||
**Output Format:**
|
||||
- Standalone HTML5 files
|
||||
- All CSS embedded in `<style>` tags
|
||||
- All SVG inline (no external images)
|
||||
- Responsive viewBox-based SVG scaling
|
||||
- Cross-browser compatible (modern browsers)
|
||||
|
||||
**File Size:**
|
||||
- Typical output: 50-150 KB
|
||||
- No external dependencies
|
||||
- Fast loading and rendering
|
||||
|
||||
**Accessibility:**
|
||||
- WCAG AA compliant color contrast (4.5:1 minimum)
|
||||
- Semantic HTML structure
|
||||
- Text labels for all visual elements
|
||||
- Keyboard navigation support
|
||||
|
||||
## Customization
|
||||
|
||||
The skill automatically adapts to your content while maintaining:
|
||||
- Consistent design language
|
||||
- Professional visual hierarchy
|
||||
- Responsive layout
|
||||
- Accessibility standards
|
||||
|
||||
Customize by providing:
|
||||
- Specific data and metrics
|
||||
- Process steps and relationships
|
||||
- Color preferences (will map to semantic system)
|
||||
- Content sections and organization
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Be specific about content** - Provide actual data, process steps, or structure
|
||||
2. **Request iterative refinement** - Ask for changes to colors, layout, or styling
|
||||
3. **Combine visualization types** - Mix flowcharts with metrics, timelines with dashboards
|
||||
4. **Save outputs** - Specify file path to save the generated HTML
|
||||
5. **Test responsiveness** - View on different screen sizes
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Issue:** SVG not displaying correctly
|
||||
- Check that the HTML is opened in a modern browser
|
||||
- Ensure file is saved with `.html` extension
|
||||
|
||||
**Issue:** Layout broken on mobile
|
||||
- The design is responsive by default
|
||||
- Verify viewport meta tag is present
|
||||
|
||||
**Issue:** Colors look different than expected
|
||||
- All colors use consistent hex values
|
||||
- Check browser color profile settings
|
||||
|
||||
## Contributing
|
||||
|
||||
Want to improve this plugin?
|
||||
|
||||
1. Fork the repository
|
||||
2. Create your feature branch
|
||||
3. Add or modify templates in `assets/templates/`
|
||||
4. Update references in `references/`
|
||||
5. Test with various content types
|
||||
6. Submit a pull request
|
||||
|
||||
## License
|
||||
|
||||
Apache 2.0 - See LICENSE file for details.
|
||||
|
||||
## Support
|
||||
|
||||
- [Open an issue](https://github.com/mhattingpete/claude-skills-marketplace/issues)
|
||||
- [Claude Code Documentation](https://docs.claude.com/en/docs/claude-code/skills)
|
||||
**Version:** 1.0.0
|
||||
|
||||
---
|
||||
|
||||
**Version:** 1.0.0
|
||||
**Author:** mhattingpete
|
||||
**Plugin Type:** Visual Documentation & Diagramming
|
||||
## Skills
|
||||
|
||||
### flowchart-creator
|
||||
|
||||
**Activates when you say:**
|
||||
- "Create a flowchart for deployment"
|
||||
- "Make a process flow diagram"
|
||||
- "Generate a decision tree"
|
||||
|
||||
**What it does:**
|
||||
Creates HTML flowcharts with color-coded stages, decision trees, arrows, and swimlanes.
|
||||
|
||||
---
|
||||
|
||||
### dashboard-creator
|
||||
|
||||
**Activates when you say:**
|
||||
- "Create a dashboard for metrics"
|
||||
- "Make a KPI visualization"
|
||||
- "Generate a performance dashboard"
|
||||
|
||||
**What it does:**
|
||||
Creates HTML dashboards with metric cards, charts, progress indicators, and data visualizations.
|
||||
|
||||
---
|
||||
|
||||
### technical-doc-creator
|
||||
|
||||
**Activates when you say:**
|
||||
- "Create API documentation"
|
||||
- "Document the architecture"
|
||||
- "Generate technical docs"
|
||||
|
||||
**What it does:**
|
||||
Creates comprehensive HTML documentation with code blocks, API workflows, and system diagrams.
|
||||
|
||||
---
|
||||
|
||||
### timeline-creator
|
||||
|
||||
**Activates when you say:**
|
||||
- "Create a project timeline"
|
||||
- "Make a roadmap"
|
||||
- "Generate a Gantt chart"
|
||||
|
||||
**What it does:**
|
||||
Creates HTML timelines and roadmaps with milestones, phase groupings, and progress indicators.
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
- Modern gradient design with semantic color system
|
||||
- Responsive, mobile-first layout
|
||||
- WCAG AA accessibility compliance
|
||||
- Self-contained HTML (no external dependencies)
|
||||
- SVG diagrams and visualizations
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
Add to your `.claude-plugin/marketplace.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"plugins": [
|
||||
{
|
||||
"name": "visual-documentation-plugin",
|
||||
"source": "github:anthropics/claude-skills-marketplace/visual-documentation-plugin",
|
||||
"version": "1.0.0"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Author
|
||||
|
||||
**mhattingpete**
|
||||
|
||||
@@ -1,262 +0,0 @@
|
||||
# Visual Documentation Plugin Setup
|
||||
|
||||
Quick setup guide for the Visual Documentation Plugin.
|
||||
|
||||
## Installation Methods
|
||||
|
||||
### Method 1: From Marketplace (Recommended)
|
||||
|
||||
```bash
|
||||
# In Claude Code terminal
|
||||
/plugin marketplace add mhattingpete/claude-skills-marketplace/visual-documentation-plugin
|
||||
```
|
||||
|
||||
### Method 2: Manual Installation
|
||||
|
||||
1. Clone or download this repository:
|
||||
```bash
|
||||
git clone https://github.com/mhattingpete/claude-skills-marketplace.git
|
||||
cd claude-skills-marketplace/visual-documentation-plugin
|
||||
```
|
||||
|
||||
2. Copy to Claude plugins directory:
|
||||
```bash
|
||||
# macOS/Linux
|
||||
cp -r visual-documentation-plugin ~/.claude/plugins/
|
||||
|
||||
# Windows
|
||||
copy visual-documentation-plugin %USERPROFILE%\.claude\plugins\
|
||||
```
|
||||
|
||||
3. Reload Claude Code
|
||||
|
||||
## Verification
|
||||
|
||||
To verify the plugin is installed correctly:
|
||||
|
||||
1. In Claude Code, type: `/skills list`
|
||||
2. You should see `visual-html-creator` in the list
|
||||
3. Test with: "Create a simple visual HTML with a flowchart showing: Start → Process → End"
|
||||
|
||||
## Quick Test
|
||||
|
||||
Try this example request:
|
||||
|
||||
```
|
||||
Create a visual HTML dashboard showing these metrics:
|
||||
- Total Users: 1,234
|
||||
- Active Today: 456
|
||||
- New Signups: 89
|
||||
- Conversion Rate: 23%
|
||||
|
||||
Include a bar chart comparing these values.
|
||||
```
|
||||
|
||||
Claude should generate a complete HTML file with metric cards and a bar chart.
|
||||
|
||||
## File Structure
|
||||
|
||||
After installation, the plugin structure is:
|
||||
|
||||
```
|
||||
visual-documentation-plugin/
|
||||
├── .claude-plugin/
|
||||
│ └── plugin.json # Plugin manifest
|
||||
├── skills/
|
||||
│ └── visual-html-creator/
|
||||
│ ├── SKILL.md # Main skill instructions
|
||||
│ ├── assets/
|
||||
│ │ └── templates/
|
||||
│ │ ├── base_template.html # Base HTML/CSS framework
|
||||
│ │ ├── flowchart_components.html # Process flow patterns
|
||||
│ │ ├── dashboard_components.html # Metric and chart patterns
|
||||
│ │ └── timeline_components.html # Timeline and roadmap patterns
|
||||
│ └── references/
|
||||
│ ├── design_patterns.md # Design system reference
|
||||
│ └── svg_library.md # SVG component library
|
||||
├── README.md # Plugin documentation
|
||||
└── SETUP.md # This file
|
||||
```
|
||||
|
||||
## Usage Patterns
|
||||
|
||||
### Basic Usage
|
||||
|
||||
Simply ask Claude to create visual documentation:
|
||||
|
||||
```
|
||||
"Create a visual HTML for [your content]"
|
||||
```
|
||||
|
||||
### Specific Visualization Types
|
||||
|
||||
**Flowchart:**
|
||||
```
|
||||
"Generate a visual flowchart showing our order processing workflow"
|
||||
```
|
||||
|
||||
**Dashboard:**
|
||||
```
|
||||
"Make a dashboard showing our Q1 performance metrics"
|
||||
```
|
||||
|
||||
**Timeline:**
|
||||
```
|
||||
"Build a timeline for our 2025 product roadmap"
|
||||
```
|
||||
|
||||
**Technical Docs:**
|
||||
```
|
||||
"Create visual HTML documenting our authentication API"
|
||||
```
|
||||
|
||||
### Advanced Usage
|
||||
|
||||
**Multiple Sections:**
|
||||
```
|
||||
"Create a comprehensive visual guide that includes:
|
||||
1. Overview metrics at the top
|
||||
2. A process flowchart showing our deployment pipeline
|
||||
3. A timeline of upcoming milestones
|
||||
4. Code examples for the API"
|
||||
```
|
||||
|
||||
**Custom Styling:**
|
||||
```
|
||||
"Create a visual HTML with a flowchart, but use green for success states
|
||||
and red for error states. Include a legend."
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
No configuration required! The skill works out of the box with:
|
||||
- Default design system (purple/blue gradient theme)
|
||||
- Semantic color palette
|
||||
- Responsive layout
|
||||
- Accessibility compliance
|
||||
|
||||
## Customization
|
||||
|
||||
To customize the design system:
|
||||
|
||||
1. Edit `assets/templates/base_template.html` for CSS changes
|
||||
2. Edit `references/design_patterns.md` for color/typography updates
|
||||
3. Edit `references/svg_library.md` for new SVG patterns
|
||||
4. Reload Claude Code to apply changes
|
||||
|
||||
## Common Tasks
|
||||
|
||||
### Change Default Colors
|
||||
|
||||
Edit `references/design_patterns.md` and update the color definitions:
|
||||
|
||||
```markdown
|
||||
**Primary gradient:**
|
||||
- Background: `linear-gradient(135deg, #YOUR_COLOR_1 0%, #YOUR_COLOR_2 100%)`
|
||||
```
|
||||
|
||||
### Add New SVG Components
|
||||
|
||||
Add patterns to `references/svg_library.md` under the appropriate section.
|
||||
|
||||
### Modify HTML Template
|
||||
|
||||
Edit `assets/templates/base_template.html` to change the default structure or CSS.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Skill not activating
|
||||
|
||||
**Issue:** Claude doesn't use the skill when requested
|
||||
|
||||
**Solutions:**
|
||||
1. Be explicit: "Create a visual HTML..." or "Generate visual documentation..."
|
||||
2. Check skill is installed: `/skills list`
|
||||
3. Reload Claude Code
|
||||
|
||||
### Generated HTML looks broken
|
||||
|
||||
**Issue:** HTML displays incorrectly in browser
|
||||
|
||||
**Solutions:**
|
||||
1. Ensure file is saved with `.html` extension
|
||||
2. Open in a modern browser (Chrome, Firefox, Safari, Edge)
|
||||
3. Check browser console for errors
|
||||
|
||||
### SVG diagrams not showing
|
||||
|
||||
**Issue:** SVG elements don't render
|
||||
|
||||
**Solutions:**
|
||||
1. Verify viewBox dimensions in SVG are appropriate
|
||||
2. Check that `<svg>` tags have `width: 100%; height: auto;`
|
||||
3. Ensure no syntax errors in SVG paths
|
||||
|
||||
### Colors look washed out
|
||||
|
||||
**Issue:** Colors appear faded or incorrect
|
||||
|
||||
**Solutions:**
|
||||
1. Check monitor color profile
|
||||
2. Verify hex color codes are correct (start with `#`)
|
||||
3. Ensure opacity is set to `1` (or omitted) for solid colors
|
||||
|
||||
## Updating
|
||||
|
||||
### Update from Marketplace
|
||||
|
||||
```bash
|
||||
/plugin marketplace update visual-documentation-skills
|
||||
```
|
||||
|
||||
### Manual Update
|
||||
|
||||
1. Pull latest changes:
|
||||
```bash
|
||||
cd claude-skills-marketplace
|
||||
git pull origin main
|
||||
```
|
||||
|
||||
2. Reinstall plugin following installation steps above
|
||||
|
||||
## Uninstalling
|
||||
|
||||
### Remove from Claude Code
|
||||
|
||||
```bash
|
||||
/plugin remove visual-documentation-skills
|
||||
```
|
||||
|
||||
### Manual Removal
|
||||
|
||||
Delete the plugin directory:
|
||||
```bash
|
||||
# macOS/Linux
|
||||
rm -rf ~/.claude/plugins/visual-documentation-plugin
|
||||
|
||||
# Windows
|
||||
rmdir /s %USERPROFILE%\.claude\plugins\visual-documentation-plugin
|
||||
```
|
||||
|
||||
## Getting Help
|
||||
|
||||
- **Issues:** [Open an issue](https://github.com/mhattingpete/claude-skills-marketplace/issues)
|
||||
- **Documentation:** [Claude Code Skills Guide](https://docs.claude.com/en/docs/claude-code/skills)
|
||||
- **Examples:** Check the `examples/` directory (if present) for sample outputs
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. ✅ Install the plugin
|
||||
2. ✅ Run verification test
|
||||
3. ✅ Try example requests
|
||||
4. 🚀 Create your first visual documentation!
|
||||
|
||||
Try these starter prompts:
|
||||
- "Create a simple flowchart showing a login process"
|
||||
- "Make a dashboard with 4 metric cards"
|
||||
- "Generate a timeline for a 3-month project"
|
||||
- "Build a visual guide for an API endpoint"
|
||||
|
||||
---
|
||||
|
||||
**Need more examples?** Check the main README.md for detailed use cases and output examples.
|
||||
@@ -0,0 +1,436 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>System Monitoring Dashboard</title>
|
||||
<style>
|
||||
/* ===== RESET & BASE ===== */
|
||||
* {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
body {
|
||||
font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
|
||||
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
|
||||
padding: 40px 20px;
|
||||
min-height: 100vh;
|
||||
}
|
||||
|
||||
/* ===== CONTAINER ===== */
|
||||
.container {
|
||||
max-width: 1400px;
|
||||
margin: 0 auto;
|
||||
background: white;
|
||||
border-radius: 20px;
|
||||
box-shadow: 0 20px 60px rgba(0,0,0,0.3);
|
||||
padding: 40px;
|
||||
}
|
||||
|
||||
/* ===== TYPOGRAPHY ===== */
|
||||
h1 {
|
||||
text-align: center;
|
||||
color: #2d3748;
|
||||
font-size: 2.5em;
|
||||
margin-bottom: 10px;
|
||||
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
|
||||
-webkit-background-clip: text;
|
||||
-webkit-text-fill-color: transparent;
|
||||
background-clip: text;
|
||||
}
|
||||
|
||||
.subtitle {
|
||||
text-align: center;
|
||||
color: #718096;
|
||||
font-size: 1.1em;
|
||||
margin-bottom: 40px;
|
||||
}
|
||||
|
||||
h2.section-title {
|
||||
font-size: 1.8em;
|
||||
color: #2d3748;
|
||||
margin-bottom: 20px;
|
||||
padding-bottom: 10px;
|
||||
border-bottom: 3px solid #667eea;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-size: 1.4em;
|
||||
color: #2d3748;
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
/* ===== LAYOUT SECTIONS ===== */
|
||||
.section {
|
||||
margin-bottom: 60px;
|
||||
}
|
||||
|
||||
.diagram-container {
|
||||
background: #f7fafc;
|
||||
border-radius: 15px;
|
||||
padding: 30px;
|
||||
margin: 20px 0;
|
||||
border: 2px solid #e2e8f0;
|
||||
}
|
||||
|
||||
/* ===== METRIC CARDS ===== */
|
||||
.metric-grid {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
|
||||
gap: 20px;
|
||||
margin: 30px 0;
|
||||
}
|
||||
|
||||
.metric-card {
|
||||
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
|
||||
color: white;
|
||||
padding: 25px;
|
||||
border-radius: 15px;
|
||||
text-align: center;
|
||||
box-shadow: 0 4px 15px rgba(102, 126, 234, 0.3);
|
||||
}
|
||||
|
||||
.metric-value {
|
||||
font-size: 2.5em;
|
||||
font-weight: bold;
|
||||
margin-bottom: 5px;
|
||||
}
|
||||
|
||||
.metric-label {
|
||||
font-size: 0.9em;
|
||||
opacity: 0.9;
|
||||
}
|
||||
|
||||
/* Status badges */
|
||||
.status-badge {
|
||||
display: inline-block;
|
||||
padding: 4px 12px;
|
||||
border-radius: 12px;
|
||||
font-size: 0.85em;
|
||||
font-weight: 600;
|
||||
margin-top: 8px;
|
||||
}
|
||||
|
||||
.status-good { background: #48bb78; }
|
||||
.status-warning { background: #f59e0b; }
|
||||
.status-critical { background: #f56565; }
|
||||
|
||||
/* ===== ALERT BOX ===== */
|
||||
.alert-container {
|
||||
background: #fff5f5;
|
||||
border-left: 4px solid #f56565;
|
||||
padding: 20px;
|
||||
border-radius: 8px;
|
||||
margin: 20px 0;
|
||||
}
|
||||
|
||||
.alert-item {
|
||||
padding: 10px 0;
|
||||
border-bottom: 1px solid #fed7d7;
|
||||
}
|
||||
|
||||
.alert-item:last-child {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
.alert-time {
|
||||
color: #718096;
|
||||
font-size: 0.85em;
|
||||
}
|
||||
|
||||
.alert-message {
|
||||
color: #2d3748;
|
||||
font-weight: 500;
|
||||
margin-top: 4px;
|
||||
}
|
||||
|
||||
/* ===== PROGRESS BARS ===== */
|
||||
.progress-container {
|
||||
margin: 15px 0;
|
||||
}
|
||||
|
||||
.progress-label {
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
margin-bottom: 8px;
|
||||
font-size: 0.95em;
|
||||
color: #2d3748;
|
||||
}
|
||||
|
||||
.progress-bar-bg {
|
||||
background: #e2e8f0;
|
||||
height: 30px;
|
||||
border-radius: 15px;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
.progress-bar-fill {
|
||||
height: 100%;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
color: white;
|
||||
font-weight: 600;
|
||||
font-size: 0.85em;
|
||||
transition: width 0.3s ease;
|
||||
}
|
||||
|
||||
/* ===== SVG STYLING ===== */
|
||||
svg {
|
||||
width: 100%;
|
||||
height: auto;
|
||||
}
|
||||
|
||||
svg text {
|
||||
font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
|
||||
}
|
||||
|
||||
/* ===== FOOTER ===== */
|
||||
.footer {
|
||||
text-align: center;
|
||||
margin-top: 60px;
|
||||
padding: 30px;
|
||||
background: #f7fafc;
|
||||
border-radius: 10px;
|
||||
}
|
||||
|
||||
.footer p {
|
||||
margin: 10px 0;
|
||||
}
|
||||
|
||||
.footer-main {
|
||||
font-size: 1.1em;
|
||||
color: #4a5568;
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
.footer-sub {
|
||||
font-size: 0.95em;
|
||||
color: #718096;
|
||||
}
|
||||
|
||||
.footer-meta {
|
||||
font-size: 0.85em;
|
||||
color: #a0aec0;
|
||||
margin-top: 15px;
|
||||
}
|
||||
|
||||
/* ===== RESPONSIVE DESIGN ===== */
|
||||
@media (max-width: 768px) {
|
||||
.container {
|
||||
padding: 20px;
|
||||
}
|
||||
|
||||
h1 {
|
||||
font-size: 1.8em;
|
||||
}
|
||||
|
||||
.section-title {
|
||||
font-size: 1.4em;
|
||||
}
|
||||
|
||||
.metric-grid {
|
||||
grid-template-columns: 1fr;
|
||||
}
|
||||
|
||||
.metric-value {
|
||||
font-size: 2em;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<h1>System Monitoring Dashboard</h1>
|
||||
<p class="subtitle">Real-time application performance and health metrics</p>
|
||||
|
||||
<!-- SYSTEM METRICS -->
|
||||
<div class="section">
|
||||
<h2 class="section-title">System Metrics</h2>
|
||||
<div class="metric-grid">
|
||||
<div class="metric-card" style="background: linear-gradient(135deg, #f59e0b 0%, #d97706 100%);">
|
||||
<div class="metric-value">45%</div>
|
||||
<div class="metric-label">CPU Usage</div>
|
||||
<span class="status-badge status-good">Normal</span>
|
||||
</div>
|
||||
<div class="metric-card" style="background: linear-gradient(135deg, #f59e0b 0%, #d97706 100%);">
|
||||
<div class="metric-value">68%</div>
|
||||
<div class="metric-label">Memory Usage</div>
|
||||
<span class="status-badge status-warning">Watch</span>
|
||||
</div>
|
||||
<div class="metric-card" style="background: linear-gradient(135deg, #48bb78 0%, #38a169 100%);">
|
||||
<div class="metric-value">52%</div>
|
||||
<div class="metric-label">Disk Usage</div>
|
||||
<span class="status-badge status-good">Good</span>
|
||||
</div>
|
||||
<div class="metric-card" style="background: linear-gradient(135deg, #4299e1 0%, #2b6cb0 100%);">
|
||||
<div class="metric-value">2.3 GB/s</div>
|
||||
<div class="metric-label">Network I/O</div>
|
||||
<span class="status-badge status-good">Normal</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- APPLICATION METRICS -->
|
||||
<div class="section">
|
||||
<h2 class="section-title">Application Metrics</h2>
|
||||
<div class="metric-grid">
|
||||
<div class="metric-card" style="background: linear-gradient(135deg, #9f7aea 0%, #6b46c1 100%);">
|
||||
<div class="metric-value">1,247</div>
|
||||
<div class="metric-label">Active Users</div>
|
||||
</div>
|
||||
<div class="metric-card" style="background: linear-gradient(135deg, #4299e1 0%, #2b6cb0 100%);">
|
||||
<div class="metric-value">3,421</div>
|
||||
<div class="metric-label">Requests/sec</div>
|
||||
</div>
|
||||
<div class="metric-card" style="background: linear-gradient(135deg, #48bb78 0%, #38a169 100%);">
|
||||
<div class="metric-value">142ms</div>
|
||||
<div class="metric-label">Avg Response Time</div>
|
||||
</div>
|
||||
<div class="metric-card" style="background: linear-gradient(135deg, #f56565 0%, #e53e3e 100%);">
|
||||
<div class="metric-value">0.3%</div>
|
||||
<div class="metric-label">Error Rate</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- DATABASE METRICS WITH PROGRESS BARS -->
|
||||
<div class="section">
|
||||
<h2 class="section-title">Database Metrics</h2>
|
||||
|
||||
<div class="progress-container">
|
||||
<div class="progress-label">
|
||||
<span><strong>Query Performance</strong></span>
|
||||
<span>23ms avg</span>
|
||||
</div>
|
||||
<div class="progress-bar-bg">
|
||||
<div class="progress-bar-fill" style="width: 15%; background: linear-gradient(90deg, #48bb78, #38a169);">
|
||||
Excellent
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="progress-container">
|
||||
<div class="progress-label">
|
||||
<span><strong>Active Connections</strong></span>
|
||||
<span>45 / 100</span>
|
||||
</div>
|
||||
<div class="progress-bar-bg">
|
||||
<div class="progress-bar-fill" style="width: 45%; background: linear-gradient(90deg, #4299e1, #2b6cb0);">
|
||||
45%
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="progress-container">
|
||||
<div class="progress-label">
|
||||
<span><strong>Cache Hit Rate</strong></span>
|
||||
<span>94%</span>
|
||||
</div>
|
||||
<div class="progress-bar-bg">
|
||||
<div class="progress-bar-fill" style="width: 94%; background: linear-gradient(90deg, #48bb78, #38a169);">
|
||||
94% - Excellent
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- REQUEST DISTRIBUTION CHART -->
|
||||
<div class="section">
|
||||
<h2 class="section-title">Request Distribution</h2>
|
||||
<div class="diagram-container">
|
||||
<svg viewBox="0 0 1200 400">
|
||||
<!-- Chart title -->
|
||||
<text x="600" y="30" text-anchor="middle" font-size="18" font-weight="bold" fill="#2d3748">
|
||||
Requests by Endpoint Type
|
||||
</text>
|
||||
|
||||
<!-- Axes -->
|
||||
<line x1="100" y1="350" x2="1100" y2="350" stroke="#2d3748" stroke-width="2"/>
|
||||
<line x1="100" y1="350" x2="100" y2="80" stroke="#2d3748" stroke-width="2"/>
|
||||
|
||||
<!-- Y-axis labels -->
|
||||
<text x="80" y="355" text-anchor="end" font-size="12" fill="#718096">0</text>
|
||||
<text x="80" y="283" text-anchor="end" font-size="12" fill="#718096">1K</text>
|
||||
<text x="80" y="210" text-anchor="end" font-size="12" fill="#718096">2K</text>
|
||||
<text x="80" y="138" text-anchor="end" font-size="12" fill="#718096">3K</text>
|
||||
<text x="80" y="85" text-anchor="end" font-size="12" fill="#718096">4K</text>
|
||||
|
||||
<!-- Grid lines -->
|
||||
<line x1="100" y1="283" x2="1100" y2="283" stroke="#e2e8f0" stroke-width="1" opacity="0.5"/>
|
||||
<line x1="100" y1="210" x2="1100" y2="210" stroke="#e2e8f0" stroke-width="1" opacity="0.5"/>
|
||||
<line x1="100" y1="138" x2="1100" y2="138" stroke="#e2e8f0" stroke-width="1" opacity="0.5"/>
|
||||
|
||||
<!-- Bar 1: API Calls -->
|
||||
<rect x="180" y="130" width="160" height="220" rx="5"
|
||||
fill="#4299e1" stroke="#2b6cb0" stroke-width="2"/>
|
||||
<text x="260" y="240" text-anchor="middle" fill="white" font-size="22" font-weight="bold">
|
||||
3,421
|
||||
</text>
|
||||
<text x="260" y="380" text-anchor="middle" font-size="13" fill="#2d3748">
|
||||
API Calls
|
||||
</text>
|
||||
|
||||
<!-- Bar 2: Page Loads -->
|
||||
<rect x="400" y="160" width="160" height="190" rx="5"
|
||||
fill="#48bb78" stroke="#2f855a" stroke-width="2"/>
|
||||
<text x="480" y="255" text-anchor="middle" fill="white" font-size="22" font-weight="bold">
|
||||
2,847
|
||||
</text>
|
||||
<text x="480" y="380" text-anchor="middle" font-size="13" fill="#2d3748">
|
||||
Page Loads
|
||||
</text>
|
||||
|
||||
<!-- Bar 3: Static Assets -->
|
||||
<rect x="620" y="210" width="160" height="140" rx="5"
|
||||
fill="#9f7aea" stroke="#6b46c1" stroke-width="2"/>
|
||||
<text x="700" y="280" text-anchor="middle" fill="white" font-size="22" font-weight="bold">
|
||||
1,953
|
||||
</text>
|
||||
<text x="700" y="380" text-anchor="middle" font-size="13" fill="#2d3748">
|
||||
Static Assets
|
||||
</text>
|
||||
|
||||
<!-- Bar 4: Webhooks -->
|
||||
<rect x="840" y="280" width="160" height="70" rx="5"
|
||||
fill="#f59e0b" stroke="#d97706" stroke-width="2"/>
|
||||
<text x="920" y="320" text-anchor="middle" fill="white" font-size="22" font-weight="bold">
|
||||
542
|
||||
</text>
|
||||
<text x="920" y="380" text-anchor="middle" font-size="13" fill="#2d3748">
|
||||
Webhooks
|
||||
</text>
|
||||
</svg>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- RECENT ALERTS -->
|
||||
<div class="section">
|
||||
<h2 class="section-title">Recent Alerts</h2>
|
||||
<div class="alert-container">
|
||||
<div class="alert-item">
|
||||
<div class="alert-time">⚠ 5 minutes ago</div>
|
||||
<div class="alert-message">High memory usage warning - 68% utilization detected</div>
|
||||
</div>
|
||||
<div class="alert-item">
|
||||
<div class="alert-time">⚠ 12 minutes ago</div>
|
||||
<div class="alert-message">Slow query detected - Query took 1.2s to execute on users table</div>
|
||||
</div>
|
||||
<div class="alert-item">
|
||||
<div class="alert-time">✓ 18 minutes ago</div>
|
||||
<div class="alert-message">Cache hit rate improved - Now at 94% (target: 90%)</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- FOOTER -->
|
||||
<div class="footer">
|
||||
<p class="footer-main"><strong>System Monitoring Dashboard v2.1</strong></p>
|
||||
<p class="footer-sub">Dashboard Test - Visual Documentation Skills</p>
|
||||
<p class="footer-meta">Last Updated: October 21, 2025 - Auto-refresh every 30s</p>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,333 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>User Authentication Process</title>
|
||||
<style>
|
||||
/* ===== RESET & BASE ===== */
|
||||
* {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
body {
|
||||
font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
|
||||
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
|
||||
padding: 40px 20px;
|
||||
min-height: 100vh;
|
||||
}
|
||||
|
||||
/* ===== CONTAINER ===== */
|
||||
.container {
|
||||
max-width: 1400px;
|
||||
margin: 0 auto;
|
||||
background: white;
|
||||
border-radius: 20px;
|
||||
box-shadow: 0 20px 60px rgba(0,0,0,0.3);
|
||||
padding: 40px;
|
||||
}
|
||||
|
||||
/* ===== TYPOGRAPHY ===== */
|
||||
h1 {
|
||||
text-align: center;
|
||||
color: #2d3748;
|
||||
font-size: 2.5em;
|
||||
margin-bottom: 10px;
|
||||
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
|
||||
-webkit-background-clip: text;
|
||||
-webkit-text-fill-color: transparent;
|
||||
background-clip: text;
|
||||
}
|
||||
|
||||
.subtitle {
|
||||
text-align: center;
|
||||
color: #718096;
|
||||
font-size: 1.1em;
|
||||
margin-bottom: 40px;
|
||||
}
|
||||
|
||||
h2.section-title {
|
||||
font-size: 1.8em;
|
||||
color: #2d3748;
|
||||
margin-bottom: 20px;
|
||||
padding-bottom: 10px;
|
||||
border-bottom: 3px solid #667eea;
|
||||
}
|
||||
|
||||
/* ===== LAYOUT SECTIONS ===== */
|
||||
.section {
|
||||
margin-bottom: 60px;
|
||||
}
|
||||
|
||||
.diagram-container {
|
||||
background: #f7fafc;
|
||||
border-radius: 15px;
|
||||
padding: 30px;
|
||||
margin: 20px 0;
|
||||
border: 2px solid #e2e8f0;
|
||||
}
|
||||
|
||||
/* ===== METRIC CARDS ===== */
|
||||
.metric-grid {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
|
||||
gap: 20px;
|
||||
margin: 30px 0;
|
||||
}
|
||||
|
||||
.metric-card {
|
||||
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
|
||||
color: white;
|
||||
padding: 25px;
|
||||
border-radius: 15px;
|
||||
text-align: center;
|
||||
box-shadow: 0 4px 15px rgba(102, 126, 234, 0.3);
|
||||
}
|
||||
|
||||
.metric-value {
|
||||
font-size: 2.5em;
|
||||
font-weight: bold;
|
||||
margin-bottom: 5px;
|
||||
}
|
||||
|
||||
.metric-label {
|
||||
font-size: 0.9em;
|
||||
opacity: 0.9;
|
||||
}
|
||||
|
||||
/* ===== LEGEND ===== */
|
||||
.legend {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
gap: 20px;
|
||||
margin: 20px 0;
|
||||
padding: 20px;
|
||||
background: #edf2f7;
|
||||
border-radius: 10px;
|
||||
}
|
||||
|
||||
.legend-item {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 10px;
|
||||
}
|
||||
|
||||
.legend-box {
|
||||
width: 30px;
|
||||
height: 30px;
|
||||
border-radius: 5px;
|
||||
border: 2px solid #2d3748;
|
||||
}
|
||||
|
||||
/* ===== SVG STYLING ===== */
|
||||
svg {
|
||||
width: 100%;
|
||||
height: auto;
|
||||
}
|
||||
|
||||
svg text {
|
||||
font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
|
||||
}
|
||||
|
||||
/* ===== FOOTER ===== */
|
||||
.footer {
|
||||
text-align: center;
|
||||
margin-top: 60px;
|
||||
padding: 30px;
|
||||
background: #f7fafc;
|
||||
border-radius: 10px;
|
||||
}
|
||||
|
||||
.footer p {
|
||||
margin: 10px 0;
|
||||
}
|
||||
|
||||
.footer-main {
|
||||
font-size: 1.1em;
|
||||
color: #4a5568;
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
.footer-sub {
|
||||
font-size: 0.95em;
|
||||
color: #718096;
|
||||
}
|
||||
|
||||
.footer-meta {
|
||||
font-size: 0.85em;
|
||||
color: #a0aec0;
|
||||
margin-top: 15px;
|
||||
}
|
||||
|
||||
/* ===== RESPONSIVE DESIGN ===== */
|
||||
@media (max-width: 768px) {
|
||||
.container {
|
||||
padding: 20px;
|
||||
}
|
||||
|
||||
h1 {
|
||||
font-size: 1.8em;
|
||||
}
|
||||
|
||||
.section-title {
|
||||
font-size: 1.4em;
|
||||
}
|
||||
|
||||
.metric-grid {
|
||||
grid-template-columns: 1fr;
|
||||
}
|
||||
|
||||
.legend {
|
||||
flex-direction: column;
|
||||
gap: 10px;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<h1>User Authentication Process</h1>
|
||||
<p class="subtitle">Secure login workflow with validation and error handling</p>
|
||||
|
||||
<!-- METRIC CARDS SECTION -->
|
||||
<div class="metric-grid">
|
||||
<div class="metric-card">
|
||||
<div class="metric-value">3</div>
|
||||
<div class="metric-label">Main Steps</div>
|
||||
</div>
|
||||
<div class="metric-card">
|
||||
<div class="metric-value">2</div>
|
||||
<div class="metric-label">Decision Points</div>
|
||||
</div>
|
||||
<div class="metric-card">
|
||||
<div class="metric-value">5</div>
|
||||
<div class="metric-label">Total Stages</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- MAIN CONTENT SECTION -->
|
||||
<div class="section">
|
||||
<h2 class="section-title">Authentication Flow</h2>
|
||||
|
||||
<div class="diagram-container">
|
||||
<svg viewBox="0 0 1200 700">
|
||||
<defs>
|
||||
<marker id="arrowhead" markerWidth="10" markerHeight="10" refX="9" refY="3" orient="auto">
|
||||
<polygon points="0 0, 10 3, 0 6" fill="#2d3748"/>
|
||||
</marker>
|
||||
<marker id="arrowhead-success" markerWidth="10" markerHeight="10" refX="9" refY="3" orient="auto">
|
||||
<polygon points="0 0, 10 3, 0 6" fill="#48bb78"/>
|
||||
</marker>
|
||||
<marker id="arrowhead-error" markerWidth="10" markerHeight="10" refX="9" refY="3" orient="auto">
|
||||
<polygon points="0 0, 10 3, 0 6" fill="#f56565"/>
|
||||
</marker>
|
||||
</defs>
|
||||
|
||||
<!-- START NODE -->
|
||||
<circle cx="100" cy="100" r="50" fill="#48bb78" stroke="#2f855a" stroke-width="3" opacity="0.9"/>
|
||||
<text x="100" y="105" text-anchor="middle" fill="white" font-size="16" font-weight="bold">START</text>
|
||||
|
||||
<!-- Arrow to Step 1 -->
|
||||
<path d="M 150 100 L 250 100" stroke="#2d3748" stroke-width="3" marker-end="url(#arrowhead)"/>
|
||||
|
||||
<!-- STEP 1: User submits credentials -->
|
||||
<rect x="250" y="50" width="220" height="100" rx="10" fill="#4299e1" stroke="#2b6cb0" stroke-width="3"/>
|
||||
<text x="360" y="90" text-anchor="middle" fill="white" font-size="15" font-weight="bold">User Enters Credentials</text>
|
||||
<text x="360" y="110" text-anchor="middle" fill="white" font-size="12">Username & Password</text>
|
||||
|
||||
<!-- Arrow to Decision 1 -->
|
||||
<path d="M 470 100 L 550 100" stroke="#2d3748" stroke-width="3" marker-end="url(#arrowhead)"/>
|
||||
|
||||
<!-- DECISION 1: Valid format? -->
|
||||
<path d="M 650 50 L 750 50 L 800 100 L 750 150 L 550 150 L 500 100 Z"
|
||||
fill="#fbbf24" stroke="#d97706" stroke-width="3"/>
|
||||
<text x="650" y="95" text-anchor="middle" font-size="14" font-weight="bold">Valid Format?</text>
|
||||
<text x="650" y="115" text-anchor="middle" font-size="11">Check inputs</text>
|
||||
|
||||
<!-- NO path - Invalid format -->
|
||||
<path d="M 650 150 L 650 220 L 360 220 L 360 150" stroke="#f56565" stroke-width="3" marker-end="url(#arrowhead-error)"/>
|
||||
<text x="650" y="190" text-anchor="middle" fill="#f56565" font-weight="bold" font-size="13">NO</text>
|
||||
<text x="500" y="240" text-anchor="middle" fill="#718096" font-size="11">Show error message</text>
|
||||
|
||||
<!-- YES path - Continue to validation -->
|
||||
<path d="M 800 100 L 900 100" stroke="#48bb78" stroke-width="3" marker-end="url(#arrowhead-success)"/>
|
||||
<text x="845" y="90" text-anchor="middle" fill="#48bb78" font-weight="bold" font-size="13">YES</text>
|
||||
|
||||
<!-- STEP 2: Validate credentials -->
|
||||
<rect x="900" y="50" width="220" height="100" rx="10" fill="#9f7aea" stroke="#6b46c1" stroke-width="3"/>
|
||||
<text x="1010" y="90" text-anchor="middle" fill="white" font-size="15" font-weight="bold">Validate Credentials</text>
|
||||
<text x="1010" y="110" text-anchor="middle" fill="white" font-size="12">Check against database</text>
|
||||
|
||||
<!-- Arrow down to Decision 2 -->
|
||||
<path d="M 1010 150 L 1010 270" stroke="#2d3748" stroke-width="3" marker-end="url(#arrowhead)"/>
|
||||
|
||||
<!-- DECISION 2: Credentials valid? -->
|
||||
<path d="M 1010 370 L 1110 370 L 1160 420 L 1110 470 L 910 470 L 860 420 Z"
|
||||
fill="#fbbf24" stroke="#d97706" stroke-width="3"/>
|
||||
<text x="1010" y="415" text-anchor="middle" font-size="14" font-weight="bold">Credentials</text>
|
||||
<text x="1010" y="435" text-anchor="middle" font-size="14" font-weight="bold">Valid?</text>
|
||||
|
||||
<!-- NO path - Invalid credentials -->
|
||||
<path d="M 860 420 L 750 420" stroke="#f56565" stroke-width="3" marker-end="url(#arrowhead-error)"/>
|
||||
<text x="800" y="410" text-anchor="middle" fill="#f56565" font-weight="bold" font-size="13">NO</text>
|
||||
|
||||
<!-- Error box -->
|
||||
<rect x="550" y="370" width="200" height="100" rx="10" fill="#f56565" stroke="#c53030" stroke-width="3"/>
|
||||
<text x="650" y="405" text-anchor="middle" fill="white" font-size="15" font-weight="bold">✗ LOGIN FAILED</text>
|
||||
<text x="650" y="430" text-anchor="middle" fill="white" font-size="12">Show error message</text>
|
||||
<text x="650" y="450" text-anchor="middle" fill="white" font-size="11">Retry allowed</text>
|
||||
|
||||
<!-- YES path - Success -->
|
||||
<path d="M 1010 470 L 1010 570" stroke="#48bb78" stroke-width="3" marker-end="url(#arrowhead-success)"/>
|
||||
<text x="1030" y="520" text-anchor="start" fill="#48bb78" font-weight="bold" font-size="13">YES</text>
|
||||
|
||||
<!-- Success box -->
|
||||
<rect x="910" y="570" width="200" height="100" rx="10" fill="#48bb78" stroke="#2f855a" stroke-width="3"/>
|
||||
<text x="1010" y="605" text-anchor="middle" fill="white" font-size="15" font-weight="bold">✓ SUCCESS</text>
|
||||
<text x="1010" y="630" text-anchor="middle" fill="white" font-size="12">User authenticated</text>
|
||||
<text x="1010" y="650" text-anchor="middle" fill="white" font-size="11">Redirect to dashboard</text>
|
||||
|
||||
<!-- Loop back from error -->
|
||||
<path d="M 650 370 L 650 280 L 360 280 L 360 150" stroke="#cbd5e0" stroke-width="2"
|
||||
stroke-dasharray="5,5" marker-end="url(#arrowhead)"/>
|
||||
<text x="500" y="300" text-anchor="middle" fill="#718096" font-size="10">Retry</text>
|
||||
|
||||
</svg>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- LEGEND SECTION -->
|
||||
<div class="legend">
|
||||
<div class="legend-item">
|
||||
<div class="legend-box" style="background: #4299e1;"></div>
|
||||
<span>User Action</span>
|
||||
</div>
|
||||
<div class="legend-item">
|
||||
<div class="legend-box" style="background: #9f7aea;"></div>
|
||||
<span>System Process</span>
|
||||
</div>
|
||||
<div class="legend-item">
|
||||
<div class="legend-box" style="background: #fbbf24;"></div>
|
||||
<span>Decision Point</span>
|
||||
</div>
|
||||
<div class="legend-item">
|
||||
<div class="legend-box" style="background: #48bb78;"></div>
|
||||
<span>Success</span>
|
||||
</div>
|
||||
<div class="legend-item">
|
||||
<div class="legend-box" style="background: #f56565;"></div>
|
||||
<span>Error/Failed</span>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- FOOTER -->
|
||||
<div class="footer">
|
||||
<p class="footer-main"><strong>User Authentication Process v1.0</strong></p>
|
||||
<p class="footer-sub">Flowchart Test - Visual Documentation Skills</p>
|
||||
<p class="footer-meta">Generated: October 21, 2025</p>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user