documentation
技術ドキュメントの生成
متاح أيضًا من: DaoThiHuong2111,Joseph OBrien,Joseph OBrien,CrazySwami,BfdCampos
このスキルは、API ドキュメント、README ファイル、アーキテクチャ文書を含む技術ドキュメントの作成を自動化します。開発者が手作業なしで一貫性のあるプロフェッショナルなドキュメントを維持できるよう支援します。
تنزيل ZIP المهارة
رفع في Claude
اذهب إلى Settings → Capabilities → Skills → Upload skill
فعّل وابدأ الاستخدام
اختبرها
استخدام "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
}
```
التدقيق الأمني
مخاطر عالية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)
مشكلات متوسطة المخاطر (1)
مشكلات منخفضة المخاطر (1)
عوامل الخطر
⚙️ الأوامر الخارجية (61)
⚡ يحتوي على سكربتات
الأنماط المكتشفة
درجة الجودة
ماذا يمكنك بناءه
API ドキュメント生成
エンドポイント、パラメータ、レスポンスタイプを含む、ソースコードから包括的な API ドキュメントを自動生成します。
プロジェクト README 作成
はじめにガイド、インストール手順、コントリビューションガイドラインを含む完成された README ファイルを作成します。
コードコメントの強化
インラインコードコメントと docstrings を追加または改善して、コードの可読性と保守性を向上させます。
جرّب هذه الموجهات
このプロジェクトの README.md ファイルを生成してください。以下のセクションを含めてください:プロジェクト名、説明、インストール、使用方法、コントリビューション、ライセンス。
以下のコードの API ドキュメントを生成してください。エンドポイントの説明、パラメータの詳細、リクエスト/レスポンスの例、エラーコードを含めてください。
システム概要、コンポーネント図の説明、データフロー、このコードベースの設計決定を含むアーキテクチャドキュメントを作成してください。
以下のコードに包括的なインラインコメントと docstrings を追加してください。複雑なロジックを説明し、パラメータと戻り値を文書化し、ファイルにヘッダーコメントを追加してください。
أفضل الممارسات
- 希望するドキュメントの形式と構造について、明確で具体的な指示を提供する
- 更新を依頼する際は、既存のドキュメントやコードのコンテキストを含める
- 公開前に生成されたドキュメントの技術的な正確性をレビューする
- ドキュメント全体で一貫したフォーマットとスタイルガイドラインを使用する
تجنب
- ソースコードやコンテキストを提供せずにドキュメント作成を依頼する
- 実行なしにスキルが実行時の動作を理解することを期待する
- 手動での技術レビューなしに生成されたドキュメントのみに依存する
- コメントや構造がないコードのドキュメントを生成する