المهارات documentation
📦

documentation

مخاطر عالية ⚙️ الأوامر الخارجية⚡ يحتوي على سكربتات

技術ドキュメントの生成

متاح أيضًا من: DaoThiHuong2111,Joseph OBrien,Joseph OBrien,CrazySwami,BfdCampos

このスキルは、API ドキュメント、README ファイル、アーキテクチャ文書を含む技術ドキュメントの作成を自動化します。開発者が手作業なしで一貫性のあるプロフェッショナルなドキュメントを維持できるよう支援します。

يدعم: Claude Codex Code(CC)
⚠️ 57 ضعيف
1

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

2

رفع في Claude

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

3

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

اختبرها

استخدام "documentation". CSV ファイルを処理する Python CLI ツールの README を生成

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

# CSV Processor CLI

A command-line tool for processing and transforming CSV files.

## Installation

```bash
pip install csv-processor
```

## Usage

```bash
csv-processor input.csv --output output.csv --transform uppercase
```

## Features
- Read and write CSV files
- Apply transformations
- Filter rows by condition
- Export to multiple formats

استخدام "documentation". この API エンドポイントを文書化:POST /users/{id}/orders

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

## Create User Order

**Endpoint:** `POST /users/{id}/orders`

Creates a new order for a specific user.

### Parameters
- `id` (path, required): User's unique identifier
- `items` (body, required): Array of order items
- `shipping_address` (body, required): Delivery address

### Response
```json
{
"order_id": "ord_123",
"status": "pending",
"total": 99.99
}
```

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

مخاطر عالية
v1 • 2/24/2026

Static analysis detected 72 potential security issues including 61 instances of shell command execution, 11 references to weak cryptographic algorithms, and 2 instances of system reconnaissance patterns. These patterns are highly unusual for a documentation skill and require manual review. The high density of external command invocations and security-related patterns suggests this skill may contain functionality beyond simple documentation generation.

1
الملفات التي تم فحصها
262
الأسطر التي تم تحليلها
5
النتائج
1
إجمالي عمليات التدقيق

مشكلات عالية المخاطر (1)

Weak Cryptographic Algorithm References
The skill contains 11 references to weak cryptographic algorithms. This is unusual for a documentation skill and may indicate the skill implements cryptographic functionality rather than just documenting it. Possible legitimate use: educational content about crypto vulnerabilities. Possible malicious: actual weak crypto implementation.
مشكلات متوسطة المخاطر (1)
Ruby/Shell Backtick Command Execution
The skill contains 61 instances of Ruby/shell backtick execution. While a documentation tool might legitimately invoke documentation generators via shell, the volume is unusual and warrants verification that commands are hardcoded and safe.
مشكلات منخفضة المخاطر (1)
System Reconnaissance Patterns
The skill contains 2 references to system reconnaissance patterns. This is highly unusual for a documentation skill and may indicate the skill performs system enumeration rather than just documenting code.

الأنماط المكتشفة

Shell Command Execution via BackticksCryptographic Weakness References
تم تدقيقه بواسطة: claude

درجة الجودة

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

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

API ドキュメント生成

エンドポイント、パラメータ、レスポンスタイプを含む、ソースコードから包括的な API ドキュメントを自動生成します。

プロジェクト README 作成

はじめにガイド、インストール手順、コントリビューションガイドラインを含む完成された README ファイルを作成します。

コードコメントの強化

インラインコードコメントと docstrings を追加または改善して、コードの可読性と保守性を向上させます。

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

基本的な README 生成
このプロジェクトの README.md ファイルを生成してください。以下のセクションを含めてください:プロジェクト名、説明、インストール、使用方法、コントリビューション、ライセンス。
API ドキュメント
以下のコードの API ドキュメントを生成してください。エンドポイントの説明、パラメータの詳細、リクエスト/レスポンスの例、エラーコードを含めてください。
アーキテクチャドキュメント
システム概要、コンポーネント図の説明、データフロー、このコードベースの設計決定を含むアーキテクチャドキュメントを作成してください。
コードコメント
以下のコードに包括的なインラインコメントと docstrings を追加してください。複雑なロジックを説明し、パラメータと戻り値を文書化し、ファイルにヘッダーコメントを追加してください。

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

  • 希望するドキュメントの形式と構造について、明確で具体的な指示を提供する
  • 更新を依頼する際は、既存のドキュメントやコードのコンテキストを含める
  • 公開前に生成されたドキュメントの技術的な正確性をレビューする
  • ドキュメント全体で一貫したフォーマットとスタイルガイドラインを使用する

تجنب

  • ソースコードやコンテキストを提供せずにドキュメント作成を依頼する
  • 実行なしにスキルが実行時の動作を理解することを期待する
  • 手動での技術レビューなしに生成されたドキュメントのみに依存する
  • コメントや構造がないコードのドキュメントを生成する

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

このスキルはあらゆるプログラミング言語のドキュメントを生成できますか?
はい、Python、JavaScript、Java、Go、Ruby を含むほとんどの人気言語をサポートしています。品質はコード構造と既存のコメントに依存します。
実行中のアプリケーションへのアクセスが必要ですか?
いいえ、静的ソースコードからドキュメントを生成します。実行中のアプリケーションは必要ありません。
既存のドキュメントを更新できますか?
はい、既存のドキュメントを提供して、スキルに更新、強化、またはコード変更に合わせた同期を依頼できます。
どのような形式を出力できますか?
主な出力は Markdown ですが、HTML、プレーンテキストも生成でき、特定のドキュメントシステム向けにフォーマットできます。
生成された API ドキュメントの正確性はどの程度ですか?
正確性はコードの品質に依存します。明確な関数シグネチャとコメントを持つ構造化されたコードは正確なドキュメントを生成します。複雑なロジックは手動レビューが必要な場合があります。
マイクロサービスアーキテクチャを文書化できますか?
はい、関連するコードと設定ファイルが提供されれば、サービスの相互作用、API 契約、システムアーキテクチャを文書化できます。

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

المؤلف

sickn33

الترخيص

MIT

مرجع

main

بنية الملفات

📄 SKILL.md