skills.rest
Awakehsh
AwakehshCOMMUNITY
Explore all skills by this author →
GitHub

example-skill

Provides a scaffold and directory layout for creating SKILL.md-based skills with required frontmatter fields.

5|11|Updated Jan 18, 2026
Search Tags:#workflow#template#documentation#skill-development#skill#SKILL.md#example-skill
One-click install
npx skills add https://github.com/Awakehsh/awesome-agent-tools --skill example-skill-awakehsh
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: example-skill
Source: https://github.com/Awakehsh/awesome-agent-tools/tree/main/docs/example-skill
Command: npx skills add https://github.com/Awakehsh/awesome-agent-tools --skill example-skill-awakehsh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill provides a ready-to-use template to ensure every new skill follows the standard SKILL.md structure, including mandatory frontmatter and a clear directory layout.

Core Features & Use Cases

  • Provides a compliant SKILL.md scaffold with required fields (name, description) and optional metadata.
  • Demonstrates a recommended directory layout (README.md, scripts/, references/, assets/).
  • Serves as an educational reference for skill authors writing consistent, maintainable documents.

Quick Start

Copy the example-skill folder, rename it to your skill's name, and update SKILL.md frontmatter with your own name and description. Then adapt or replace the example components to fit your use case.

Frequently Asked Questions about example-skill

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What is a SKILL.md file and when do I need it for skill development?▼

A SKILL.md file defines a skill's metadata and structure for consistent organization. You need it when creating new skills to ensure a standard directory layout with required frontmatter fields like name and description.

How do I create a well-formed skill using a SKILL.md template?▼

To create a skill using a SKILL.md template, copy the template directory, rename it, and update the SKILL.md frontmatter with your skill's name and description. Then adapt the scripts and references folders to fit your use case.

What directory layout should I use for skill development?▼

A standard skill development directory layout includes a SKILL.md file, a README.md, and dedicated folders for scripts, references, and assets. This structure ensures maintainable and well-organized skill documentation.

Do I need frontmatter in my SKILL.md file?▼

Yes, you need frontmatter in your SKILL.md file. A minimal frontmatter schema enforces required name and description fields, ensuring your skill is properly documented and compliant with skill standards.

What's the best way to organize skill documentation and examples?▼

The best way to organize skill documentation is separating examples and references into dedicated directories. Following a standard template ensures your skill documentation remains consistent, clear, and maintainable across projects.

Related Skills

Explore More Software Engineering Skills→
PiklarPiklar

speckit-git-initialize

Initialize a Git repository with an initial commit in Bash or PowerShell.

Community
Intermediate
pradyumnasagarpradyumnasagar
6

cross-reference-mapper

Generate and validate cross-references between ORS skills.

Community
Intermediate
thec3ukthec3uk

Global Validation

Enforce coding-standard compliance for global validation across code files.

Official
Basic
EstomEstom

code-documenter

Generate framework-aware documentation with docstrings, OpenAPI specs, and doc sites.

Community
Advanced