writing-skills

Validate SKILL.md frontmatter and body structure for skill documentation.

Updated Dec 24, 2025
One-click install
npx skills add https://github.com/yairbederman/EngineeringAgency --skill writing-skills-yairbederman
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-skills
Source: https://github.com/yairbederman/EngineeringAgency/tree/main/skills/writing-skills
Command: npx skills add https://github.com/yairbederman/EngineeringAgency --skill writing-skills-yairbederman

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing Skills provides a structured approach to authoring, testing, and validating skills so that teams can reuse proven patterns rather than rely on ad-hoc narratives.

Core Features & Use Cases

  • Structured frontmatter and mandatory sections ensure discoverability.
  • Supports adding optional resources (scripts/references/assets) for richer skills documentation.
  • Facilitates test-driven documentation by defining checklists, common mistakes, and pre-completion steps for quality control.

Quick Start

Draft a new skill by adding SKILL.md with name and description, fill in the core sections, and validate the structure against the template.

Frequently Asked Questions about writing-skills

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

FAQPage Schema
How do I structure skill documentation for repeatable discovery?

Structure skill documentation by creating a SKILL.md file with YAML frontmatter containing mandatory name and description fields, followed by a body with operational instructions. This enforces discoverability and standardizes validation.

What is the best way to validate reusable skills before publishing?

Validate reusable skills by applying test-driven documentation checklists and safety checks against the SKILL.md template. This prevents toxic content and insecure configurations while verifying mandatory frontmatter fields.

How do I add scripts and references to skill documentation?

Add scripts and references to skill documentation by utilizing optional resources directories. This supports richer skills documentation by allowing you to attach assets alongside the core SKILL.md file.

Can I use YAML frontmatter to enforce mandatory fields in skill templates?

Yes, you can use YAML frontmatter to enforce mandatory fields in skill templates. The validation process checks this frontmatter to ensure that both name and description fields are present for proper skill discovery.

Why does skill discovery fail when editing existing documentation?

Skill discovery fails when SKILL.md frontmatter is missing mandatory name and description fields. Validation checks enforce this structure to ensure operational instructions remain discoverable and standardized across edits.

What common mistakes break skill validation checklists?

Common mistakes that break skill validation checklists include omitting mandatory YAML frontmatter, missing operational instructions in the body, and failing safety checks for toxic content or insecure configurations.