DocumentationBeginner

SKILL.md

What is 'Skilled Out MD'?

SKILL.md

What is it?

SKILL.md (or "Skilled Out MD") is a documentation standard used to describe the capabilities, context, and usage instructions for a specific directory or component within an agentic codebase.

Why use it?

Agents often struggle to understand the intent behind a folder just by looking at file names. SKILL.md provides a high-density, context-rich summary that agents can read to instantly "skill up" on that part of the codebase.

Structure

1. Purpose

Define what this directory/component does in 1-2 sentences.

2. Key Files

List the most important files and their roles.

3. Usage

  • Input: What data does it need?
  • Output: What does it produce?
  • Dependencies: What else does it rely on?

Example

# Auth Module Skills

## Purpose
Handles user authentication and session management via Firebase.

## Key Files
- `auth-context.tsx`: React Context provider.
- `firebase.ts`: Firebase initialization.

## Usage
Import `useAuth` hook to access `user` object and `signOut` method.

Implementation via Agents

When an agent enters a directory, it should first look for SKILL.md to ground its understanding before modifying code.