writing-skills

Create, edit, and validate Skills documentation with YAML frontmatter.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/lightxue/dotfiles --skill writing-skills-lightxue
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: writing-skills
Source: https://github.com/lightxue/dotfiles/tree/main/agent/skills/writing-skills
Command: npx skills add https://github.com/lightxue/dotfiles --skill writing-skills-lightxue

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Skill authors face inconsistent guidance and untested documentation when creating or updating Skills. This section provides a concise, frontmatter-driven blueprint to ensure every Skill is discoverable, well-structured, and verifiable before deployment.

Core Features & Use Cases

  • Structured frontmatter: Enforces required name and description fields to power discovery.
  • Progressive disclosure: Keeps core guidance lightweight and links to heavy references as needed.
  • Testing workflow: Prescribes a RED-GREEN-REFACTOR approach to validate new Skills under realistic scenarios.

Quick Start

Create a new SKILL.md with a name and a description that starts with Use when..., then implement a minimal example to verify the workflow.

Frequently Asked Questions about writing-skills

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

FAQPage Schema
How do I create and validate Skills documentation before deployment?▼

Create and validate Skills by drafting a SKILL.md file with required YAML frontmatter, then applying a RED-GREEN-REFACTOR testing workflow to verify behavior under realistic trigger scenarios before deployment.

What's the best way to structure YAML frontmatter for Skill discovery?▼

Structure YAML frontmatter by including required name and description fields, keeping the description under 1024 characters and starting with Use when... to ensure concise, trigger-focused content for optimal Skill discovery.

Does writing Skills require any specific dependencies or frameworks?▼

Writing Skills requires no external dependencies or frameworks, only a SKILL.md file with valid YAML frontmatter and optional references, assets, or scripts added progressively as needed for validation.

How does the RED-GREEN-REFACTOR testing approach apply to Skill creation?▼

The RED-GREEN-REFACTOR approach validates Skill behavior by first writing a failing test for a trigger scenario, implementing the minimal Skill logic to pass it, then refactoring the documentation for clarity and discoverability.

Can I add external references and scripts to a SKILL.md file?▼

You can add optional references, assets, and scripts to a SKILL.md file as needed, keeping core guidance lightweight through progressive disclosure while linking to heavy external resources for validation.

Why does my Skill fail discovery checks despite having valid documentation?▼

Skill discovery fails when the YAML frontmatter lacks a concise, trigger-focused description starting with Use when..., or when the description exceeds the 1024 character limit required for consistent indexing.