| name | help-system |
| description | Displays help information, usage instructions, and available commands or features when users request assistance or guidance. Use this skill when users type --help, ask for help, need usage instructions, or want to see available commands. |
Help System
Overview
This skill provides comprehensive help information to users who need assistance with commands, features, or usage instructions. It identifies the context of help requests, gathers relevant documentation, formats the information clearly, and presents it to users in an accessible manner.
When to Use
Activate this skill when:
- User types
--help or similar help flags
- User explicitly asks for help or assistance
- User needs usage instructions for commands or features
- User wants to see available commands or options
- User appears confused about how to use a feature
How It Works
Step 1: Identify Context
Analyze the user's request to determine:
- Specific command or feature they need help with
- Level of detail required (overview vs detailed usage)
- User's apparent experience level
- Context of their current task or workflow
Step 2: Gather Help Content
Read relevant documentation and references:
- Access
references/help-documentation.md for general help content
- Consult
references/command-reference.md for specific command information
- Identify applicable usage examples and best practices
- Collect troubleshooting information if relevant
Step 3: Format Help Output
Structure the help information for clarity:
- Organize content logically (overview, syntax, examples, options)
- Use consistent formatting with headers, lists, and code blocks
- Include relevant examples and use cases
- Add cross-references to related commands or concepts
- Ensure information is concise but complete
Step 4: Display Help
Present the formatted help information:
- Write the help content in a clear, scannable format
- Use appropriate emphasis for important information
- Include quick reference sections for common tasks
- Provide links or references to additional resources when helpful
Best Practices
- Be Contextual: Tailor help content to the specific request rather than providing generic information
- Use Examples: Include practical examples that users can immediately apply
- Structure Clearly: Use headings, bullet points, and formatting to make information easy to scan
- Keep Current: Ensure help information reflects current features and syntax
- Be Concise: Provide essential information without overwhelming the user
Output Format
Structure help output with these sections as appropriate:
- Overview: Brief description of the command or feature
- Syntax: Command structure and required/optional parameters
- Options: Available flags and their descriptions
- Examples: Common usage scenarios with sample commands
- Related: Links to related commands or concepts
- Notes: Important considerations or limitations
Error Handling
- If specific help topic is not found, provide general help menu
- Suggest similar commands or topics if exact match unavailable
- Gracefully handle malformed help requests
- Offer to search documentation for partial matches
