About template-skill
template-skill is a scaffold for writing agent skill documentation. It provides sections for prerequisites, step-by-step execution, verification, examples, and troubleshooting, with placeholders to customize.
Key features
- 01Overview and activation guidance
- 02Prerequisite checklist
- 03Step-by-step execution sections
- 04Verification instructions
- 05Usage example templates
- 06Troubleshooting table
Use cases
- 01Draft documentation for a new agent skill
- 02Organize skill prerequisites and workflow
- 03Add examples and verification steps
- 04Document common problems and fixes
Install
Copy the command and run it in a terminal.
$
npx skills add https:/After installing, type/template-skillin Claude Code to confirm it loaded.
Details
From the project READMESkill Name
Overview
Brief explanation of:
- What problem this skill solves
- When it should be activated
- Expected inputs and outputs
Prerequisites
- List environment requirements
- Required tools, packages, or access
Execution
Step 1: First action
-> Tell user: Status update
Explain what to do, with executable examples:
command --example
Step 2: Second action
-> Tell user: Status update
Continue the workflow.
Step 3: Verification
Verify the result:
verification_command
-> Tell user: Report results. On failure, diagnose and fix.
Examples
Example 1: Typical usage
User says: "/skill-name argument"
Actions:
1. Parse input
2. Execute workflow
3. Verify result
Result: Description of expected outcome
Example 2: Edge case
User says: "alternative trigger phrase"
Actions:
1. Handle the edge case
2. Adapt workflow accordingly
Result: Description of expected outcome
Troubleshooting
| Problem | Cause | Fix |
|---|---|---|
| Common error 1 | Typical cause | How to fix |
| Common error 2 | Typical cause | How to fix |
Comments
Markdown supported