المهارات writing-docs
📦

writing-docs

آمن

Professionelle Dokumentation mit Best Practices generieren

Das Schreiben klarer Dokumentation ist herausfordernd und zeitaufwendig. Diese Skill generiert automatisch umfassende Dokumentation mithilfe sprachspezifischer Vorlagen und Best Practices der Branche und stellt sicher, dass Ihr Code gut dokumentiert und wartbar ist.

يدعم: Claude Codex Code(CC)
📊 71 كافٍ
1

تنزيل ZIP المهارة

2

رفع في Claude

اذهب إلى Settings → Capabilities → Skills → Upload skill

3

فعّل وابدأ الاستخدام

اختبرها

استخدام "writing-docs". Document this function: function calculateDiscount(price, percentage) { return price * (1 - percentage / 100); }

النتيجة المتوقعة:

/**
* Calculates the discounted price by applying a percentage discount.
*
* @param {number} price - The original price before discount
* @param {number} percentage - The discount percentage (0-100)
* @returns {number} The final price after applying the discount
*
* @example
* // Calculate 20% off $100
* const finalPrice = calculateDiscount(100, 20);
* // Returns: 80
*
* @example
* // Calculate 15% off $50.99
* const finalPrice = calculateDiscount(50.99, 15);
* // Returns: 43.3415
*/

استخدام "writing-docs". Create a README for a weather API wrapper library

النتيجة المتوقعة:

  • # Weather API Wrapper
  • A simple, lightweight JavaScript wrapper for popular weather APIs with built-in caching and error handling.
  •  
  • ## Features
  • - Support for multiple weather providers (OpenWeather, WeatherAPI)
  • - Built-in response caching to reduce API calls
  • - TypeScript support with full type definitions
  • - Promise-based async API with error handling
  •  
  • ## Installation
  • ```bash
  • npm install weather-api-wrapper
  • ```
  •  
  • ## Quick Start
  • ```javascript
  • import WeatherAPI from 'weather-api-wrapper';
  •  
  • const weather = new WeatherAPI({ apiKey: 'your-key' });
  • const forecast = await weather.getForecast('London');
  • console.log(forecast.temperature);
  • ```

التدقيق الأمني

آمن
v6 • 1/21/2026

This skill is completely safe. Static analysis flagged 89 patterns, but all are false positives from markdown documentation examples. The skill contains only documentation templates and guidelines with no executable code, network requests, or command execution. All detected patterns are markdown formatting (code fences, backticks) and example placeholder URLs in documentation templates.

2
الملفات التي تم فحصها
1,275
الأسطر التي تم تحليلها
0
النتائج
6
إجمالي عمليات التدقيق
لا توجد مشكلات أمنية
تم تدقيقه بواسطة: claude عرض سجل التدقيق →

درجة الجودة

38
الهندسة المعمارية
100
قابلية الصيانة
87
المحتوى
30
المجتمع
100
الأمان
91
الامتثال للمواصفات

ماذا يمكنك بناءه

Neue API-Endpunkte dokumentieren

Softwareentwickler können diese Skill verwenden, um schnell umfassende API-Dokumentation für neue Endpunkte zu generieren, einschließlich Parameterbeschreibungen, Antwortformaten, Fehlercodes und Verwendungsbeispielen.

Fehlende Docstrings zu Legacy-Code hinzufügen

Engineering-Teams, die Legacy-Codebasen pflegen, können systematisch ordnungsgemäße Docstrings zu undokumentierten Funktionen und Klassen hinzufügen, wodurch die Code-Wartbarkeit und das Onboarding für neue Teammitglieder verbessert werden.

Projekt-README-Dateien erstellen

Open-Source-Maintainer und Projektinhaber können professionelle README-Dateien mit ordnungsgemäßer Struktur generieren, einschließlich Features, Installationsanweisungen, Verwendungsbeispielen und Beitragsrichtlinien.

جرّب هذه الموجهات

Funktions-Docstring generieren
Dokumentiere diese Funktion mit einer klaren Beschreibung, Parametertypen, Rückgabewert und einem Verwendungsbeispiel
Projekt-README erstellen
Erstelle eine umfassende README für dieses Projekt einschließlich Installationsanweisungen, Feature-Liste, Verwendungsbeispielen und API-Referenz
JSDoc zu Modul hinzufügen
Füge JSDoc-Kommentare zu allen öffentlichen Funktionen in diesem Modul mit Parameterbeschreibungen, Rückgabetypen und Beispielen für jede hinzu
API-Endpunkte dokumentieren
Generiere API-Dokumentation für diese Endpunkte einschließlich Request-Parameter, Response-Schema, Statuscodes und curl-Beispielen

أفضل الممارسات

  • Fügen Sie immer mindestens ein funktionierendes Code-Beispiel in die Funktionsdokumentation ein. Beispiele helfen Entwicklern, die Verwendung schneller zu verstehen als Beschreibungen allein.
  • Dokumentieren Sie alle Parameter mit ihren Typen und ob sie optional sind. Geben Sie Standardwerte an, wenn zutreffend, um Verwirrung zu vermeiden.
  • Schreiben Sie die erste Zeile als klare, prägnante Zusammenfassung, die für sich allein stehen kann. Viele Dokumentationstools zeigen nur die erste Zeile in Übersichten und Suchergebnissen an.

تجنب

  • Schreiben Sie keine Dokumentation, die einfach den Funktionsnamen wiederholt. Dokumentation wie 'getName() holt den Namen' bietet Entwicklern keinen Mehrwert.
  • Vermeiden Sie es, Implementierungsdetails zu dokumentieren, die sich ändern können. Konzentrieren Sie sich auf die öffentliche Schnittstelle, das Verhalten und den Vertrag statt auf interne Mechanismen.
  • Lassen Sie Beispielcode nicht ungetestet oder veraltet. Fehlerhafte Beispiele in der Dokumentation sind schlimmer als keine Beispiele und schädigen das Vertrauen der Entwickler.

الأسئلة المتكررة

Welche Dokumentationsformate unterstützt diese Skill?
Die Skill unterstützt JSDoc für JavaScript und TypeScript, Google-Stil-Docstrings für Python, Standard-Kommentarformate für Go und Rust sowie Markdown für README-Dateien und allgemeine Dokumentation. Sie bietet sprachspezifische Vorlagen für jedes Format.
Kann diese Skill automatisch Dokumentation durch Analyse meines Codes generieren?
Nein, diese Skill bietet Vorlagen und Best Practices zum Schreiben von Dokumentation, leitet aber nicht automatisch das Funktionsverhalten aus Code-Analyse ab. Sie müssen Informationen darüber bereitstellen, was der Code tut, und die Skill formatiert es ordnungsgemäß.
Wie passe ich den Dokumentationsstil für mein Projekt an?
Die Skill bietet Standardvorlagen als Ausgangspunkt. Sie können Änderungen anfordern, um Ihrem Projekt-Style-Guide zu entsprechen, wie z.B. das Ändern des Docstring-Formats, Hinzufügen benutzerdefinierter Abschnitte oder Anpassen des Detailgrads in Beispielen.
Funktioniert dies mit Dokumentationsgenerierungstools wie JSDoc oder Sphinx?
Ja, die von dieser Skill generierten Dokumentationsformate sind mit gängigen Dokumentationstools kompatibel. JSDoc-Kommentare funktionieren mit JSDoc, TypeDoc und ähnlichen Tools. Python-Docstrings funktionieren mit Sphinx, pdoc und anderen Python-Dokumentationsgeneratoren.
Kann diese Skill bestehende Dokumentation aktualisieren, anstatt neue Dokumentation zu erstellen?
Ja, Sie können die Skill bitten, bestehende Dokumentation zu überprüfen und zu verbessern. Sie kann fehlende Abschnitte hinzufügen, die Klarheit verbessern, Beispiele hinzufügen oder Dokumentation neu formatieren, um Best Practices zu folgen, während Ihr ursprünglicher Inhalt erhalten bleibt.
Was ist der Unterschied zwischen dieser Skill und dem einfachen Bitten von Claude Code, Dokumentation zu schreiben?
Diese Skill bietet spezialisierte Vorlagen, sprachspezifische Formatierung und strukturierte Best Practices für Dokumentation. Sie gewährleistet Konsistenz, folgt Industriestandards und umfasst umfassende Abschnitte wie Parameter, Rückgabewerte, Fehler und Beispiele, die bei allgemeinen Anfragen möglicherweise übersehen werden.

تفاصيل المطور

بنية الملفات

📄 SKILL.md