writing-skills

Validate SKILL.md frontmatter and extract metadata from Skill directories.

Updated Nov 8, 2024
One-click install
npx skills add https://github.com/cqkxxc/cqkxxc.github.io --skill writing-skills-cqkxxc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-skills
Source: https://github.com/cqkxxc/cqkxxc.github.io/tree/main/.trae/skills/writing-skills
Command: npx skills add https://github.com/cqkxxc/cqkxxc.github.io --skill writing-skills-cqkxxc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing skills are essential for ensuring consistent, testable documentation and governance around Skill creation, editing, and verification.

Core Features & Use Cases

  • Provides a standardized template and guidelines for Skill documentation, including frontmatter, structure, and validation steps.
  • Describes how to write, test (TDD-inspired), and verify Skills before deployment to reduce drift and failures.
  • Includes references to best practices and testing workflows to accelerate Skill authoring.

Quick Start

Review the SKILL.md and draft the metadata and verification steps following the writing-skills guidelines.

Frequently Asked Questions about writing-skills

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

FAQPage Schema
How do I validate Skill documentation frontmatter before deployment?

Skill documentation validation requires checking the root SKILL.md frontmatter for mandatory name and description fields. This process identifies valid Skill units and extracts metadata to enable safe discovery and indexing.

What is the TDD approach for writing and testing Skill documentation?

TDD-style Skill documentation applies a red-green-refactor workflow to write, test, and verify Skills. This standardized template reduces drift and failures by validating structure and governance before deployment.

How does Skill discovery load optional resources like scripts and assets?

Skill discovery scans for optional scripts/, references/, and assets/ directories. It loads these resources on demand only when the SKILL.md file explicitly references them.

What metadata is generated from SKILL.md for safe Skill indexing?

Indexing generates a structured metadata block from SKILL.md containing dependencies, components, and a toxicity_check assessment. This output enables safe discovery by validating mandatory frontmatter fields.

Are there prerequisites for standardizing Skill creation with TDD-style docs?

Standardizing Skill creation requires drafting a SKILL.md file with frontmatter, structure, and verification steps. Reviewing the writing-skills guidelines provides the standardized template needed to ensure testable documentation.