Skills

Write and maintain SKILL.md files with validated frontmatter and runnable Quick Start sections.

3.6k|225|Updated Dec 19, 2023
One-click install
npx skills add https://github.com/atopile/atopile --skill skills-atopile
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Skills
Source: https://github.com/atopile/atopile/tree/main/.claude/skills/skills
Command: npx skills add https://github.com/atopile/atopile --skill skills-atopile

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a structured workflow to write and maintain SKILL.md files (entry points for skills) so that documentation remains accurate, verifiable, and aligned with code.

Core Features & Use Cases

  • Source-of-truth workflow for skill documentation to avoid drift between docs and implementation.
  • Verification steps and conventions that ensure frontmatter validity, cross-referenced paths, and consistent structure.
  • Runnable Quick Start examples that demonstrate how a Skill is activated and used within the repository.

Quick Start

Update a target SKILL.md using the recommended frontmatter fields, then add a concise Quick Start section that shows how to interact with the Skill in the repo (e.g., how to locate the SKILL.md, validate frontmatter, and run a minimal example).

Frequently Asked Questions about Skills

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

FAQPage Schema
How do I maintain SKILL.md documentation so it stays aligned with code?▼

To maintain aligned SKILL.md documentation, use a source-of-truth workflow with frontmatter validation, cross-referenced path checks, and runnable Quick Start examples to prevent drift between docs and implementation.

What is frontmatter validation for skill documentation?▼

Frontmatter validation for skill documentation is the process of enforcing invariant checks and consistent conventions on metadata fields in SKILL.md files to ensure accurate, verifiable entries across repository-wide skill modules.

How do I enforce invariant checks in SKILL.md files?▼

You enforce invariant checks in SKILL.md files by applying consistent conventions for frontmatter fields and cross-referenced paths, ensuring documentation maintains API traceability and remains a verifiable source-of-truth.

Does writing skill documentation require specific path or API traceability?▼

Writing skill documentation requires path and API traceability to keep docs aligned with code. Cross-referencing paths in SKILL.md files ensures the source-of-truth notes accurately reflect the repository implementation.

What's the best way to structure a SKILL.md file to avoid documentation drift?▼

The best way to structure a SKILL.md file to avoid documentation drift is including valid frontmatter, source-of-truth notes, invariant-enforcing checks, and a concise Quick Start section demonstrating runnable usage within the repository.