Skip to content

docs: add description length guideline to skill authoring #30

@galligan

Description

@galligan

Problem

Some skill descriptions are 200+ characters, making them hard to scan in /help output and skill listings.

Proposal

Add a guideline to the skill-authoring documentation:

Description length: Keep descriptions under 150 characters. Front-load the trigger conditions ("This skill should be used when...") and keep capability details brief.

Examples

Too long (217 chars):

This skill should be used when building React components with TypeScript, typing hooks, handling events, or when React TypeScript, React 19, Server Components are mentioned. Covers type-safe patterns for React 18-19 including generic components, proper event typing, and TanStack Router integration.

Better (138 chars):

This skill should be used when building React components with TypeScript, typing hooks, or handling events. Covers React 18-19 patterns.

Location

Update agent-kit/skills/skills-development/SKILL.md and related references.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions