Skip to content

Add skill creation guidelines based on superpowers writing-skills #70

@devrimcavusoglu

Description

@devrimcavusoglu

Summary

Integrate skill creation guidelines into skern's skern skill create workflow, inspired by the superpowers writing-skills skill. These guidelines should be built into skern itself so that agents (and humans) produce high-quality, discoverable, well-structured skills by default.

Motivation

Currently, skern provides the tooling for managing skills (create, install, list, search, etc.) but lacks opinionated guidance on how to write effective skills. The superpowers project has developed comprehensive skill authoring guidelines that cover:

  • When to create a skill (and when not to)
  • Skill types (technique, pattern, reference)
  • SKILL.md structure — recommended sections (Overview, When to Use, Core Pattern, Quick Reference, Common Mistakes)
  • Claude Search Optimization (CSO) — writing descriptions and keywords so agents can discover skills effectively
  • Description best practices — start with "Use when...", focus on triggering conditions, never summarize workflow (agents may shortcut and skip reading the full skill)
  • Token efficiency — keeping frequently-loaded skills concise, using cross-references, compressing examples
  • Naming conventions — verb-first, active voice, gerunds for processes
  • File organization — when to keep everything inline vs. split into supporting files
  • Code examples — one excellent example beats many mediocre ones
  • Flowchart usage — only for non-obvious decision points, never for linear instructions or reference material
  • Anti-patterns — narrative storytelling, multi-language dilution, generic labels, code in flowcharts
  • Skill creation checklist — structured checklist for quality assurance

Proposed Scope

  1. Enhance skern skill create scaffolding — embed the writing-skills guidelines into the skill creation flow itself (e.g., scaffold templates, inline comments in generated SKILL.md, validation hints). This should be the default behavior, not an opt-in flag. When an agent or human runs skern skill create, the output should naturally guide them toward well-structured skills.
  2. Update AGENTS.md — add the writing-skills guidelines as the canonical reference for how skern creates skills. Agents operating on skern should follow these guidelines when creating or editing skills.
  3. Optionally add a docs/guides/writing-skills.md page to the documentation site for human reference.

Key Principles to Incorporate

  • Description field: Should start with "Use when..." and describe triggering conditions only — never summarize the skill's workflow (agents may follow the description shortcut instead of reading the full SKILL.md)
  • Naming: Use kebab-case, verb-first active voice (e.g., creating-skills not skill-creation)
  • Token budget: Getting-started skills < 150 words; frequently-loaded < 200 words; others < 500 words
  • Structure: Overview → When to Use → Core Pattern → Quick Reference → Common Mistakes
  • One excellent example per skill, in the most relevant language
  • Flat namespace: All skills in one searchable directory
  • Supporting files only for heavy reference (100+ lines) or reusable tools

Reference

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions