open-circle/agent-skills

Overview

This skill provides a concise, actionable template for building and documenting an agent skill. Use when you need a clear step-by-step guide for implementing features, documenting prerequisites, and troubleshooting common issues. It helps agents identify relevance by including keywords like setup, examples, troubleshooting, and patterns.

How this skill works

The skill inspects a project's requirements and produces a structured set of instructions: prerequisites, step-by-step implementation, examples, and troubleshooting tips. It outlines where to add code snippets, how to run basic and advanced examples, and common patterns to reuse. It is designed to be adapted to different languages and environments by replacing placeholder code blocks with real implementations.

When to use it

• When the user asks for a step-by-step implementation guide for a new skill
• When creating or improving documentation for an agent or plugin
• When you need clear examples for basic and advanced usage
• When troubleshooting common setup or runtime issues
• When defining prerequisites and environment setup for contributors

Best practices

• Keep prerequisites minimal and explicit: list tools, versions, and environment variables
• Provide both basic and advanced examples to cover typical and edge-case workflows
• Use short, focused code blocks and comment key operations for clarity
• Document common patterns and recommended project structure to speed onboarding
• Include troubleshooting steps for frequent errors and clear links to resources

Example use cases

• Onboarding new contributors with a single ordered instruction set
• Publishing a reproducible example that demonstrates core functionality
• Creating a troubleshooting section for known runtime issues and fixes
• Providing an extensible template that can be adapted to different languages or frameworks
• Including a quick-start that shows how to run basic and advanced examples locally