効果的な説明文の書き方

スキルの説明は、発見性とユーザーの理解にとって重要です。

2つの説明

1. フロントマターの説明(200文字)

表示される場所:

  • 検索結果
  • スキルカード
  • マーケットプレイスのリスト

目標: 価値とスコープを素早く伝える。

2. コンテンツの説明(無制限)

表示される場所:

  • スキル詳細ページ
  • ドキュメント

目標: 包括的な理解を提供。

フロントマター説明のヒント

価値から始める

スキルが何かではなく、ユーザーが得るものから始める。

良い例:

「コンポーネントパターン、パフォーマンスのヒント、アクセシビリティガイドラインでよりクリーンなReactコードを書く。」

悪い例:

「このスキルにはReact開発のガイドラインが含まれています。」

キーワードを含める

検索でスキルを見つけやすくする。

良い例:

「TypeScript型安全ガイドライン:ジェネリクス、型ガード、ユーティリティ型、strictモードのベストプラクティス。」

悪い例:

「型安全なコードのためのガイドライン。」

スコープを具体的に

明確な期待を設定。

良い例:

「APIセキュリティチェックリスト:REST APIの認証、認可、入力検証、レート制限。」

悪い例:

「セキュリティのベストプラクティス。」

アクティブな言葉を使う

アクション指向にする。

良い例:

「ARIAラベル、キーボードナビゲーション、スクリーンリーダーサポートでアクセシブルなReactコンポーネントを構築。」

悪い例:

「Reactのアクセシビリティ情報。」

テンプレート

ガイドラインスキル用

[アクション] [ドメイン] with [主な機能1]、[主な機能2]、and [主な機能3]。

例:

「BEM命名、ユーティリティクラス、レスポンシブデザインパターンでメンテナンス可能なCSSを書く。」

レビュースキル用

[レビュータイプ] for [対象者]:[チェック1]、[チェック2]、and [チェック3]。

例:

「チーム向けコードレビューガイドライン:セキュリティチェック、パフォーマンス分析、スタイルの一貫性。」

統合スキル用

[統合/接続] [技術] with [アプローチ]:[機能1] and [機能2]。

例:

「ベストプラクティスでStripe決済を統合:Webhookハンドリングとエラーリカバリー。」

よくある間違い

曖昧すぎる

問題: 「より良いコードのためのガイドライン。」 改善: 「Pythonコード品質:PEP 8スタイル、型ヒント、ドキュメント標準。」

長すぎる

問題: 切り詰められる300文字以上の説明。 改善: 180文字以内に。詳細はコンテンツセクションを使用。

文脈のない専門用語

問題: 「CQRSパターンを使用したDDDのためのSOLID原則。」 改善: 「クリーンアーキテクチャパターン:単一責任、依存性注入、ドメインモデリング。」

差別化要素がない

問題: 「React開発ガイドライン。」 改善: 「Reactサーバーコンポーネント:ストリーミング、サスペンス、データフェッチングパターン。」

キーワード戦略

ユーザーが検索する可能性のある用語を含める:

| カテゴリ | キーワード | |----------|----------| | テクノロジー | React、TypeScript、Python、AWS | | ドメイン | 認証、決済、分析 | | タスク | レビュー、テスト、デプロイメント | | 品質 | セキュリティ、パフォーマンス、アクセシビリティ |

説明のテスト

  1. 検索テスト: 関連する用語で検索してこれを見つけられるか?
  2. スキャンテスト: 5秒でスキルを理解できるか?
  3. 差別化テスト: 類似のスキルとどう違うか?
  4. アクションテスト: このスキルで何をするか明確か?

次のステップ