documentation
生成技术文档
متاح أيضًا من: DaoThiHuong2111,Joseph OBrien,Joseph OBrien,CrazySwami,BfdCampos
此技能自动化创建技术文档,包括 API 文档、README 文件和架构文档。它帮助开发人员在无需手动努力的情况下维护一致、专业的文档。
تنزيل ZIP المهارة
رفع في Claude
اذهب إلى Settings → Capabilities → Skills → Upload skill
فعّل وابدأ الاستخدام
اختبرها
استخدام "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
}
```
التدقيق الأمني
مخاطر عالية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 文件,包含入门指南、安装说明和贡献指南。
代码注释增强
添加或改进内联代码注释和文档字符串,提高代码可读性和可维护性。
جرّب هذه الموجهات
Generate a README.md file for this project. Include sections for: Project title, Description, Installation, Usage, Contributing, and License.
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.
أفضل الممارسات
- 提供关于所需文档格式和结构的清晰、具体说明
- 请求更新时包含现有文档或代码上下文
- 发布前审查生成文档的技术准确性
- 在文档中使用一致的格式和风格指南
تجنب
- 在未提供源代码或上下文的情况下要求生成文档
- 期望技能在没有执行的情况下理解运行时行为
- 仅依赖生成的文档而未进行手动技术审查
- 为没有注释或结构的代码生成文档