技能 documentation
📦

documentation

高風險 ⚙️ 外部命令⚡ 包含腳本

إنشاء الوثائق التقنية

也可從以下取得: DaoThiHuong2111,Joseph OBrien,Joseph OBrien,CrazySwami,BfdCampos

يقوم هذا المهارة بأتمتة إنشاء الوثائق التقنية بما في ذلك وثائق API وملفات README والوثائق المعمارية. يساعد المطورين على الحفاظ على وثائق متسقة واحترافية دون جهد يدوي.

支援: Claude Codex Code(CC)
⚠️ 57
1

下載技能 ZIP

2

在 Claude 中上傳

前往 設定 → 功能 → 技能 → 上傳技能

3

開啟並開始使用

測試它

正在使用「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
}
```

安全審計

高風險
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 مصقولة مع أدلة البدء وتعليمات التثبيت وإرشادات المساهمة.

تحسين تعليقات الكود

إضافة أو تحسين التعليقات المضمنة ووثائق الكود لتحسين قابلية قراءة الكود وقابليته للصيانة.

試試這些提示

إنشاء README الأساسي
إنشاء ملف README.md لهذا المشروع. قم بتضمين أقسام لـ: عنوان المشروع، الوصف، التثبيت، الاستخدام، المساهمة، والترخيص.
وثائق API
إنشاء وثائق API للكود التالي. قم بتضمين أوصاف نقاط النهاية وتفاصيل المعلمات وأمثلة الطلب/الاستجابة ورموز الأخطاء.
الوثائق المعمارية
إنشاء وثائق معمارية تتضمن نظرة عامة على النظام ووصف مخططات المكونات وتدفق التصميم والقرارات التصميمية لهذا الكود المصدري.
تعليقات الكود
إضافة تعليقات شاملة مضمنة ووثائق للكود التالي. شرح المنطق المعقد، وتوثيق المعلمات والقيم المرجعة، وإضافة تعليقات头部 للملفات.

最佳實務

  • توفير تعليمات واضحة ومحددة حول تنسيق الوثائق وهيكلها المطلوب
  • تضمين الوثائق الموجودة أو سياق الكود عند طلب التحديثات
  • مراجعة الوثائق المُنشأة للدقة التقنية قبل النشر
  • استخدام إرشادات التنسيق والأنماط المتسقة عبر جميع الوثائق

避免

  • طلب الوثائق دون توفير الكود المصدري أو السياق
  • توقع أن يفهم المهارة السلوك في وقت التشغيل دون التنفيذ
  • الاعتماد فقط على الوثائق المُنشأة دون مراجعة تقنية يدوية
  • إنشاء وثائق لكود بدون تعليقات أو هيكل

常見問題

هل يمكن لهذا المهارة إنشاء وثائق لأي لغة برمجة؟
نعم، وهي تدعم معظم اللغات الشائعة بما في ذلك Python وJavaScript وJava وGo وRuby. تعتمد الجودة على هيكل الكود والتعليقات الموجودة.
هل يتطلب الوصول إلى تطبيق قيد التشغيل؟
لا، تقوم بإنشاء الوثائق من الكود المصدري الثابت. لست بحاجة إلى تطبيق قيد التشغيل.
هل يمكنها تحديث الوثائق الموجودة؟
نعم، يمكنك تقديم وثائق موجودة وطلب من المهارة تحديثها أو تحسينها أو مزامنتها مع تغييرات الكود.
ما هي التنسيقات التي يمكنها إخراجها؟
الناتج الأساسي هو Markdown،,但它也可以生成 HTML 和特定文档系统的纯文本格式。
ما مدى دقة وثائق API المُنشأة؟
الدقة تعتمد على جودة الكود. الكود المهيكل جيدًا مع توقيعات ووظائف واضحة يُنتج وثائق دقيقة. المنطق المعقد قد يتطلب مراجعة يدوية.
هل يمكنها توثيق architectures الخدمات المصغرة؟
نعم، يمكنها توثيق تفاعلات الخدمات وعقود API وarchitecture النظام عند تزويدها بالكود ذي الصلة وملفات التكوين.

開發者詳情

檔案結構

📄 SKILL.md