documentation
إنشاء الوثائق التقنية
也可從以下取得: DaoThiHuong2111,Joseph OBrien,Joseph OBrien,CrazySwami,BfdCampos
يقوم هذا المهارة بأتمتة إنشاء الوثائق التقنية بما في ذلك وثائق API وملفات README والوثائق المعمارية. يساعد المطورين على الحفاظ على وثائق متسقة واحترافية دون جهد يدوي.
下載技能 ZIP
在 Claude 中上傳
前往 設定 → 功能 → 技能 → 上傳技能
開啟並開始使用
測試它
正在使用「documentation」。 إنشاء README لأداة CLI بلغة Python لمعالجة ملفات CSV
預期結果:
# 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」。 وثيقة نقطة النهاية هذه: 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 مصقولة مع أدلة البدء وتعليمات التثبيت وإرشادات المساهمة.
تحسين تعليقات الكود
إضافة أو تحسين التعليقات المضمنة ووثائق الكود لتحسين قابلية قراءة الكود وقابليته للصيانة.
試試這些提示
إنشاء ملف README.md لهذا المشروع. قم بتضمين أقسام لـ: عنوان المشروع، الوصف، التثبيت، الاستخدام، المساهمة، والترخيص.
إنشاء وثائق API للكود التالي. قم بتضمين أوصاف نقاط النهاية وتفاصيل المعلمات وأمثلة الطلب/الاستجابة ورموز الأخطاء.
إنشاء وثائق معمارية تتضمن نظرة عامة على النظام ووصف مخططات المكونات وتدفق التصميم والقرارات التصميمية لهذا الكود المصدري.
إضافة تعليقات شاملة مضمنة ووثائق للكود التالي. شرح المنطق المعقد، وتوثيق المعلمات والقيم المرجعة، وإضافة تعليقات头部 للملفات.
最佳實務
- توفير تعليمات واضحة ومحددة حول تنسيق الوثائق وهيكلها المطلوب
- تضمين الوثائق الموجودة أو سياق الكود عند طلب التحديثات
- مراجعة الوثائق المُنشأة للدقة التقنية قبل النشر
- استخدام إرشادات التنسيق والأنماط المتسقة عبر جميع الوثائق
避免
- طلب الوثائق دون توفير الكود المصدري أو السياق
- توقع أن يفهم المهارة السلوك في وقت التشغيل دون التنفيذ
- الاعتماد فقط على الوثائق المُنشأة دون مراجعة تقنية يدوية
- إنشاء وثائق لكود بدون تعليقات أو هيكل