example-skill

スキルのテンプレート例

このスキルは、新しいスキルを作成するためのテンプレート兼ガイドです。このコードベースのすべてのスキルで使用されている標準的な構成とベストプラクティスを示します。

概要

すべてのスキルに、以下を含めてください。

• 基本ドキュメント - SKILL.md に記載する主要な概念とクイックスタートガイド
• API リファレンス - resources/ に記載するメソッド／関数の詳細なドキュメント
• コード例 - examples/ に記載する動作するコードサンプル
• スターターテンプレート - templates/ に用意する、すぐに使えるセットアップファイル
• トラブルシューティング - docs/ に記載する一般的な問題と解決策

必須の構成

skill-name/
├── SKILL.md                    # Main skill file (required)
├── resources/                  # API references and detailed docs
│   ├── api-reference.md
│   └── program-addresses.md
├── examples/                   # Working code examples
│   └── feature-name/
│       └── example.ts
├── templates/                  # Starter templates
│   └── setup.ts
└── docs/                       # Guides and troubleshooting
    └── troubleshooting.md

SKILL.md の形式

フロントマター（必須）

すべての SKILL.md は YAML フロントマターから始める必要があります。

---
name: skill-name
description: Brief description of what this skill covers. Should be 1-2 sentences explaining the protocol/tool and main features.
---

推奨セクション

# Protocol Name Development Guide

Brief introduction paragraph.

## Overview

Bullet points of main features:
- **Feature 1** - Description
- **Feature 2** - Description

## Program IDs (for Solana protocols)

| Program | Address |
|---------|---------|
| Main Program | `address` |

## Quick Start

### Installation

\`\`\`bash
npm install package-name
\`\`\`

### Basic Setup

\`\`\`typescript
// Setup code example
\`\`\`

## Core Features

Document each major feature with:
- Explanation
- Code examples
- Important notes

## Best Practices

- Security considerations
- Performance tips
- Common patterns

## Resources

- Links to official docs
- GitHub repositories
- Community resources

## Skill Structure

Show the actual file structure of this skill.

執筆ガイドライン

コード例

1. 必ずインポートを含める - 完全で実行可能なコードを示します
2. TypeScript を使用する - 適切な型を指定した .ts ファイルを優先します
3. コメントを追加する - 一見して分かりにくいロジックを説明します
4. エラーを処理する - 適切なエラー処理のパターンを示します
5. 実際のアドレスを使用する - プレースホルダーではなく、実際のプログラム ID を使用します

ドキュメントのスタイル

1. 簡潔にする - すぐに要点を伝えます
2. 表を使う - メソッド、アドレス、パラメーターの一覧に使用します
3. 説明より実例を示す - 長い説明よりコード例を優先します
4. 最新の状態に保つ - バージョン情報と更新日を記載します

リソースファイル

以下の内容について、resources/ に個別のファイルを作成します。

• API メソッドの完全なリファレンス
• プログラムアドレスと PDA
• 設定オプション
• 型定義

例のファイル

examples/ の例は、以下の条件を満たす必要があります。

• 単独で実行できる
• コメントが十分に記載されている
• 一般的なユースケースを網羅している
• エラー処理が含まれている

テンプレートファイル

templates/ のテンプレートは、以下の条件を満たす必要があります。

• コピーしてすぐに使える
• 設定オプションが含まれている
• プレースホルダーの値が明確に示されている
• 必要なインポートがすべて含まれている

プロトコルスキルの例

一般的な Solana プロトコルスキルの構成例を示します。

---
name: protocol-name
description: Complete guide for Protocol Name - description of what it does.
---

# Protocol Name Development Guide

## Overview

Protocol Name provides:
- **Feature A** - What it does
- **Feature B** - What it does

## Program IDs

| Program | Address |
|---------|---------|
| Main | \`ProgramAddress111111111111111111111\` |

## Quick Start

### Installation

\`\`\`bash
npm install @protocol/sdk
\`\`\`

### Basic Setup

\`\`\`typescript
import { Protocol } from '@protocol/sdk';

const protocol = new Protocol(connection);
\`\`\`

## Core Operations

### Operation 1

\`\`\`typescript
// Code example
\`\`\`

### Operation 2

\`\`\`typescript
// Code example
\`\`\`

## Best Practices

- Practice 1
- Practice 2

## Resources

- [Official Docs](https://docs.protocol.com)
- [GitHub](https://github.com/protocol/sdk)

## Skill Structure

\`\`\`
protocol-name/
├── SKILL.md
├── resources/
│   ├── api-reference.md
│   └── program-addresses.md
├── examples/
│   └── basic/
│       └── example.ts
├── templates/
│   └── setup.ts
└── docs/
    └── troubleshooting.md
\`\`\`

新しいスキルのチェックリスト

• 適切なフロントマターを含む SKILL.md
• 機能一覧を含む概要セクション
• プログラム ID の表（Solana プロトコルの場合）
• インストールとセットアップを含むクイックスタート
• コード例を含む主要な操作
• ベストプラクティスのセクション
• 外部リンクを含むリソース
• スキル構成図
• API リファレンスを含む resources/
• 動作するコードを含む examples/
• スターターテンプレートを含む templates/
• 一般的な問題を記載した docs/troubleshooting.md

スキルの構成

example-skill/
├── SKILL.md                    # This file
├── resources/
│   └── api-reference.md        # Example API reference format
├── examples/
│   └── basic/
│       └── example.ts          # Example code file
├── templates/
│   └── setup.ts                # Example template
└── docs/
    └── troubleshooting.md      # Example troubleshooting guide