Effektive Beschreibungen schreiben
Die Beschreibung Ihres Skills ist entscheidend für die Auffindbarkeit und das Benutzerverständnis.
Die zwei Beschreibungen
1. Frontmatter-Beschreibung (200 Zeichen)
Erscheint in:
- Suchergebnissen
- Skill-Karten
- Marktplatz-Listings
Ziel: Wert und Umfang schnell kommunizieren.
2. Inhaltsbeschreibung (unbegrenzt)
Erscheint in:
- Skill-Detailseite
- Dokumentation
Ziel: Umfassendes Verständnis vermitteln.
Tipps für Frontmatter-Beschreibungen
Mit dem Wert beginnen
Beginnen Sie damit, was der Benutzer gewinnt, nicht was der Skill ist.
Gut:
"Schreiben Sie saubereren React-Code mit Komponenten-Patterns, Leistungstipps und Barrierefreiheits-Richtlinien."
Schlecht:
"Dieser Skill enthält Richtlinien für die React-Entwicklung."
Schlüsselwörter einbeziehen
Helfen Sie Benutzern, Ihren Skill über die Suche zu finden.
Gut:
"TypeScript-Typsicherheits-Richtlinien: Generics, Type Guards, Utility Types und Strict-Mode-Best-Practices."
Schlecht:
"Richtlinien für typsicheren Code."
Spezifisch über den Umfang sein
Setzen Sie klare Erwartungen.
Gut:
"API-Sicherheits-Checkliste: Authentifizierung, Autorisierung, Eingabevalidierung und Rate-Limiting für REST-APIs."
Schlecht:
"Sicherheits-Best-Practices."
Aktive Sprache verwenden
Machen Sie es handlungsorientiert.
Gut:
"Erstellen Sie barrierefreie React-Komponenten mit ARIA-Labels, Tastaturnavigation und Screenreader-Unterstützung."
Schlecht:
"Barrierefreiheits-Informationen für React."
Vorlagen
Für Richtlinien-Skills
[Aktion] [Bereich] mit [Hauptfunktion 1], [Hauptfunktion 2] und [Hauptfunktion 3].
Beispiel:
"Schreiben Sie wartbares CSS mit BEM-Namensgebung, Utility-Klassen und Responsive-Design-Patterns."
Für Review-Skills
[Review-Typ] für [Zielgruppe]: [Prüfung 1], [Prüfung 2] und [Prüfung 3].
Beispiel:
"Code-Review-Richtlinien für Teams: Sicherheitsprüfungen, Leistungsanalyse und Stil-Konsistenz."
Für Integrations-Skills
[Integrieren/Verbinden] [Technologie] mit Best Practices: [Funktion 1] und [Funktion 2].
Beispiel:
"Stripe-Zahlungen mit Best Practices integrieren: Webhook-Behandlung und Fehlerwiederherstellung."
Häufige Fehler
Zu vage
Problem: "Richtlinien für besseren Code." Besser: "Python-Codequalität: PEP-8-Stil, Type Hints und Dokumentationsstandards."
Zu lang
Problem: Beschreibungen mit über 300 Zeichen, die abgeschnitten werden. Besser: Unter 180 Zeichen bleiben. Verwenden Sie den Inhaltsabschnitt für Details.
Fachjargon ohne Kontext
Problem: "SOLID-Prinzipien für DDD mit CQRS-Patterns." Besser: "Clean-Architecture-Patterns: Single Responsibility, Dependency Injection und Domain-Modellierung."
Kein Unterscheidungsmerkmal
Problem: "React-Entwicklungsrichtlinien." Besser: "React Server Components: Streaming, Suspense und Data-Fetching-Patterns."
Schlüsselwort-Strategie
Fügen Sie Begriffe ein, nach denen Benutzer suchen könnten:
| Kategorie | Schlüsselwörter | |----------|----------| | Technologie | React, TypeScript, Python, AWS | | Bereich | Authentifizierung, Zahlungen, Analytics | | Aufgabe | Review, Testen, Deployment | | Qualität | Sicherheit, Leistung, Barrierefreiheit |
Beschreibung testen
- Suchtest: Würden Sie diese bei der Suche nach verwandten Begriffen finden?
- Scan-Test: Können Sie den Skill in 5 Sekunden verstehen?
- Differenzierungstest: Wie unterscheidet sich dieser von ähnlichen Skills?
- Aktionstest: Ist klar, was Sie mit diesem Skill tun werden?
Nächste Schritte
- Teststrategie - Skill überprüfen
- Beispiele - Gute Beschreibungen in Aktion sehen