Initial commit

skills/claude-code-marketplace/templates/standard/docs/GUIDE.md

@@ -0,0 +1,343 @@
+# [Marketplace Name] - User Guide
+
+## Table of Contents
+
+1. [Installation](#installation)
+2. [Getting Started](#getting-started)
+3. [Available Plugins](#available-plugins)
+4. [Available Skills](#available-skills)
+5. [Usage Examples](#usage-examples)
+6. [Configuration](#configuration)
+7. [Troubleshooting](#troubleshooting)
+
+## Installation
+
+### Prerequisites
+
+- Claude Code Pro subscription
+- Git installed and configured
+- Node.js 18+ (for development)
+
+### Adding the Marketplace
+
+1. Add the marketplace to Claude Code:
+
+   ```bash
+   /plugin marketplace add [repository-url]
+   ```
+
+2. Verify installation:
+   ```bash
+   /plugin marketplace list
+   ```
+
+### Installing Plugins
+
+Browse available plugins:
+
+```bash
+/plugin
+```
+
+Install specific plugin:
+
+```bash
+/plugin install [plugin-name]@[marketplace-name]
+```
+
+## Getting Started
+
+### First Steps
+
+1. **Install Core Plugins**: Start with essential plugins for your workflow
+2. **Explore Skills**: Test different skills to understand their capabilities
+3. **Configure Settings**: Adjust plugin settings according to your needs
+4. **Read Documentation**: Review individual plugin and skill documentation
+
+### Basic Workflow
+
+```bash
+# 1. List available tools
+/help
+
+# 2. Use a command from installed plugin
+/[plugin-command] [options]
+
+# 3. Use a skill directly
+"Perform task using [skill-name]"
+
+# 4. Check plugin status
+/plugin info [plugin-name]
+```
+
+## Available Plugins
+
+### [Plugin Name 1]
+
+**Description**: [Detailed description]
+
+**Commands**:
+
+- `[command-1]`: [Description]
+- `[command-2]`: [Description]
+
+**Examples**:
+
+```bash
+/[command-1] --option value
+/[command-2] input.txt
+```
+
+### [Plugin Name 2]
+
+**Description**: [Detailed description]
+
+**Commands**:
+
+- `[command-1]`: [Description]
+- `[command-2]`: [Description]
+
+**Examples**:
+
+```bash
+/[command-1] --option value
+/[command-2] input.txt
+```
+
+## Available Skills
+
+### [Skill Name 1]
+
+**Category**: [category]
+
+**Description**: [Detailed description]
+
+**When to Use**: [Usage scenarios]
+
+**Examples**:
+
+```bash
+"Use [skill-name] to [perform task]"
+"Process this file using [skill-name]"
+```
+
+### [Skill Name 2]
+
+**Category**: [category]
+
+**Description**: [Detailed description]
+
+**When to Use**: [Usage scenarios]
+
+**Examples**:
+
+```bash
+"Use [skill-name] to [perform task]"
+"Process this file using [skill-name]"
+```
+
+## Usage Examples
+
+### Example 1: [Task Name]
+
+```bash
+# Step 1: Install required plugin
+/plugin install [plugin-name]@[marketplace-name]
+
+# Step 2: Use the command
+/[command] [options] [input]
+
+# Step 3: Use supporting skill
+"Complete the task using [skill-name]"
+```
+
+### Example 2: [Task Name]
+
+```bash
+# Step 1: Install multiple plugins
+/plugin install [plugin-1]@[marketplace-name]
+/plugin install [plugin-2]@[marketplace-name]
+
+# Step 2: Combine commands
+/[command-1] [options]
+/[command-2] [options]
+
+# Step 3: Use skill for final processing
+"Process results using [skill-name]"
+```
+
+## Configuration
+
+### Plugin Settings
+
+Most plugins support configuration through settings files or command-line options.
+
+#### Configuration File Location
+
+- **Global**: `~/.claude/settings.json`
+- **Project**: `.claude/settings.json`
+
+#### Example Configuration
+
+```json
+{
+  "plugins": {
+    "[plugin-name]": {
+      "option1": "value1",
+      "option2": "value2"
+    }
+  }
+}
+```
+
+### Skill Configuration
+
+Skills can be configured through their SKILL.md files or at runtime.
+
+## Troubleshooting
+
+### Common Issues
+
+#### Plugin Installation Fails
+
+**Problem**: Plugin won't install or shows errors
+
+**Solution**:
+
+```bash
+# Check marketplace connection
+/plugin marketplace list
+
+# Update marketplace
+/plugin marketplace update [marketplace-name]
+
+# Try alternative installation
+/plugin install [plugin-name]@[marketplace-name] --force
+```
+
+#### Commands Not Available
+
+**Problem**: Installed plugin commands don't appear in `/help`
+
+**Solution**:
+
+```bash
+# Check plugin status
+/plugin info [plugin-name]
+
+# Restart Claude Code
+# Exit and restart Claude Code
+
+# Verify installation
+/plugin list
+```
+
+#### Skills Not Loading
+
+**Problem**: Skills don't trigger or work correctly
+
+**Solution**:
+
+```bash
+# Check skill availability
+/skill-list
+
+# Test skill manually
+"Test [skill-name] functionality"
+
+# Check skill configuration
+/skill-info [skill-name]
+```
+
+### Getting Help
+
+If you encounter issues:
+
+1. **Check Documentation**: Review individual plugin/skill documentation
+2. **Search Issues**: Look for similar issues in GitHub repository
+3. **Ask Community**: Post questions in discussions or issues
+4. **Report Bugs**: Create detailed issue reports with reproduction steps
+
+### Debug Mode
+
+Enable debug mode for troubleshooting:
+
+```bash
+claude --debug
+claude --verbose
+```
+
+## Best Practices
+
+### Plugin Usage
+
+1. **Start Small**: Begin with essential plugins
+2. **Read Documentation**: Understand plugin capabilities before use
+3. **Test Incrementally**: Test plugins with small tasks first
+4. **Monitor Performance**: Watch for performance impacts
+
+### Skill Usage
+
+1. **Be Specific**: Provide clear instructions and context
+2. **Use Examples**: Include example inputs when asking for help
+3. **Iterate**: Refine requests based on results
+4. **Provide Feedback**: Report issues and suggest improvements
+
+### Workspace Management
+
+1. **Organize Projects**: Use dedicated directories for different projects
+2. **Clean Regularly**: Remove unused plugins and skills
+3. **Backup Configuration**: Save your settings and preferences
+4. **Update Regularly**: Keep plugins and marketplace updated
+
+## Advanced Usage
+
+### Custom Workflows
+
+Combine multiple plugins and skills for complex workflows:
+
+```bash
+# Example: Document processing workflow
+/[plugin-1] extract-text document.pdf
+"Analyze extracted text using [skill-name]"
+/[plugin-2] format-output --type markdown
+```
+
+### Script Integration
+
+Integrate with external scripts and automation:
+
+```bash
+# Example: Batch processing
+for file in *.txt; do
+  claude "Process $file using [skill-name]"
+done
+```
+
+### API Integration
+
+Some plugins support API integration for external services:
+
+```json
+{
+  "plugins": {
+    "[plugin-name]": {
+      "api_key": "your-api-key",
+      "endpoint": "https://api.example.com"
+    }
+  }
+}
+```
+
+---
+
+## Resources
+
+- **Official Documentation**: [Link to docs]
+- **Community Forum**: [Link to forum]
+- **GitHub Repository**: [Link to repo]
+- **Video Tutorials**: [Link to videos]
+
+---
+
+_Last updated: [Date]_