writing-skills

Catalog and codify AI agent skills using SKILL.md, REFERENCE.md, and STATE_MACHINE.md.

1.5k|875|Updated Aug 20, 2021
One-click install
npx skills add https://github.com/saleor/storefront --skill writing-skills-saleor
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-skills
Source: https://github.com/saleor/storefront/tree/main/.claude/skills/writing-skills
Command: npx skills add https://github.com/saleor/storefront --skill writing-skills-saleor

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This YAML frontmatter-based pattern helps teams standardize the creation, review, and maintenance of AI agent skills for this project, ensuring consistent discovery and activation.

Core Features & Use Cases

  • Defines a reusable skill structure with required frontmatter (name, description) and a modular file layout under .claude/skills/[skill-name]/ including SKILL.md, REFERENCE.md, STATE_MACHINE.md, and examples.
  • Encourages progressive disclosure by linking deeper references only when needed, enabling fast startup and richer depth for advanced usage.
  • Guides project teams on when to create, update, or retire skills to reflect changing requirements and platform capabilities.

Quick Start

Review or create a new skill entry by editing SKILL.md and placing it under .claude/skills with proper frontmatter.

Frequently Asked Questions about writing-skills

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

FAQPage Schema
How do I standardize AI agent skills documentation for consistent discovery?

To standardize AI agent skills documentation, use a YAML frontmatter-based pattern with required fields like name and description. This ensures consistent discovery and activation across project teams by codifying skill structure in modular files such as SKILL.md.

What is the modular file layout for organizing Claude AI agent skills?

The modular file layout for organizing Claude AI agent skills places files under .claude/skills/[skill-name]/. This structure includes SKILL.md for core definitions, REFERENCE.md for deeper context, STATE_MACHINE.md for advanced guidance, and supporting examples.

When should I create, update, or retire modular AI skills in a project?

You should create, update, or retire modular AI skills when project requirements or platform capabilities change. Regularly reviewing skills ensures your documentation reflects current needs and prevents outdated workflows from cluttering the system.

How does progressive disclosure work for AI agent skill references?

Progressive disclosure for AI agent skills works by linking deeper references only when needed. This enables fast startup with basic SKILL.md frontmatter while providing richer depth through supporting files like REFERENCE.md and STATE_MACHINE.md for advanced usage.

Do I need YAML frontmatter to structure AI agent workflows?

Yes, YAML frontmatter is required to structure AI agent workflows effectively. It provides essential metadata like name and description for skill activation, ensuring the skill can be properly discovered and referenced by developers and AI agents.

What's the best way to catalog and codify AI agent skills for development teams?

The best way to catalog and codify AI agent skills is implementing a reusable YAML frontmatter pattern with a modular file layout. This provides concise, production-ready descriptions of skill roles and integration points for developers and Claude-like agents.