スキル一覧に戻る
ian-pascoe

writing-skills

by ian-pascoe

My dotfiles

1🍴 0📅 2026年1月24日
GitHubで見るManusで実行

SKILL.md


name: writing-skills description: Use when creating, editing, or reviewing SKILL.md files for AI agents. Covers frontmatter requirements, naming conventions, structure patterns, and common mistakes.

Writing Skills

Overview

Skills are reusable reference guides that help AI agents find and apply effective techniques. A skill is NOT a narrative - it's a pattern, technique, or reference that applies broadly.

When to Use

  • Creating a new skill from a discovered technique
  • Editing or improving an existing skill
  • Reviewing skill quality before deployment
  • Unsure if something should be a skill vs project-specific docs

Don't create skills for: one-off solutions, project-specific conventions (use AGENTS.md), or things enforceable via automation.

File Structure

.opencode/skill/<name>/SKILL.md     # Project-local
~/.config/opencode/skill/<name>/    # Global/personal

Directory name MUST match the name field in frontmatter.

Frontmatter Requirements

Only two fields are recognized:

---
name: skill-name-here
description: Use when [specific triggering conditions and symptoms]
---

Name rules:

  • 1-64 characters
  • Lowercase alphanumeric with single hyphens
  • No leading/trailing hyphens, no consecutive --
  • Regex: ^[a-z0-9]+(-[a-z0-9]+)*$

Description rules:

  • 1-1024 characters (aim for <500)
  • Start with "Use when..." - focus on triggers, not workflow
  • Third person (injected into system prompt)
  • NEVER summarize the skill's process

Quick Reference

ElementRequirementExample
Namelowercase, hyphenated, 1-64 charscondition-based-waiting
Description"Use when..." + triggers only"Use when tests flake due to timing"
Overview1-2 sentences, core principleWhat + Why
When to UseSymptoms + exclusionsInclude "Don't use for"
Quick ReferenceScannable tableMost-needed info at a glance
Common MistakesTable formatMistake | Fix
Validation ChecklistCheckboxesFinal quality gate

Document Structure

## Overview

Core principle in 1-2 sentences.

## When to Use

Symptoms and triggering conditions.
When NOT to use.

## Core Pattern

Before/after or key technique.

## Quick Reference

Table or bullets for scanning.

## Common Mistakes

What goes wrong + fixes.

Common Mistakes

MistakeFix
Description summarizes workflowOnly include triggering conditions
Generic name like helper-utilsUse active voice: condition-based-waiting
Narrative storytellingExtract reusable pattern
Multiple mediocre examplesOne excellent, complete example
Heavy content inlineSplit to supporting files if >100 lines

Validation Checklist

  • Name matches directory and follows naming rules
  • Description starts with "Use when..."
  • Description does NOT summarize the skill's workflow
  • Written in third person
  • Includes triggering symptoms/conditions
  • Has quick reference for scanning
  • No narrative or session-specific content

スコア

総合スコア

50/100

リポジトリの品質指標に基づく評価

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

0/10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

0/5

レビュー

💬

レビュー機能は近日公開予定です