المهارات 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". Generate a README for a Python CLI tool that processes CSV files

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

# 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". Document this API endpoint: 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 生成
Generate a README.md file for this project. Include sections for: Project title, Description, Installation, Usage, Contributing, and License.
API 文档
Generate API documentation for the following code. Include endpoint descriptions, parameter details, request/response examples, and error codes.
架构文档
Create architecture documentation including system overview, component diagram descriptions, data flow, and design decisions for this codebase.
代码注释
Add comprehensive inline comments and docstrings to the following code. Explain complex logic, document parameters and return values, and add header comments to files.

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

  • 提供关于所需文档格式和结构的清晰、具体说明
  • 请求更新时包含现有文档或代码上下文
  • 发布前审查生成文档的技术准确性
  • 在文档中使用一致的格式和风格指南

تجنب

  • 在未提供源代码或上下文的情况下要求生成文档
  • 期望技能在没有执行的情况下理解运行时行为
  • 仅依赖生成的文档而未进行手动技术审查
  • 为没有注释或结构的代码生成文档

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

此技能可以为任何编程语言生成文档吗?
是的,它支持大多数流行语言,包括 Python、JavaScript、Java、Go 和 Ruby。质量取决于代码结构和现有注释。
它需要访问运行的应用程序吗?
不,它从静态源代码生成文档。您不需要运行的应用程序。
它可以更新现有文档吗?
是的,您可以提供现有文档并要求技能更新、增强或使其与代码更改同步。
它可以输出什么格式?
主要输出是 Markdown,但它也可以生成 HTML、纯文本,并为特定文档系统格式化。
生成的 API 文档有多准确?
准确性取决于代码质量。结构良好、具有清晰函数签名和注释的代码会产生准确的文档。复杂逻辑可能需要手动审查。
它可以记录微服务架构吗?
是的,当提供相关代码和配置文件时,它可以记录服务交互、API 合约和系统架构。

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

المؤلف

sickn33

الترخيص

MIT

مرجع

main

بنية الملفات

📄 SKILL.md