example-skill

Use this template to scaffold skill documentation with enforced sections: Overview, When to use this skill, Protocol, Examples, Red flags, Requirements, and Related resources. The structured format ensures machine-readable output for RAG indexing and consistent metadata across your skill library.

Include Overview, Protocol steps, Examples, Red flags, Requirements, and Related resources. This template provides the complete structure for documenting workflow and CLI-based skills, ensuring all critical information is present and properly formatted for discovery.

Yes. Copy the template and replace placeholders with your existing skill details. The guidance helps you reorganize current documentation into the standardized sections, making it consistent with the broader skill ecosystem.

A standardized template enforces consistent structure across skills, enabling reliable parsing for indexing and search. It reduces documentation drift, ensures critical sections like Protocol and Red flags aren't missed, and improves discoverability within the tooling ecosystem.

The template enforces mandatory metadata fields alongside structured content sections, ensuring each skill is machine-readable and properly indexed. Metadata captures skill identity and enables filtering, categorization, and RAG-based retrieval.