documentation
Generate Technical Documentation
也可從以下取得: DaoThiHuong2111,Joseph OBrien,Joseph OBrien,CrazySwami,BfdCampos
This skill automates the creation of technical documentation including API docs, README files, and architecture documents. It helps developers maintain consistent, professional documentation without manual effort.
下載技能 ZIP
在 Claude 中上傳
前往 設定 → 功能 → 技能 → 上傳技能
開啟並開始使用
測試它
正在使用「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 Documentation Generation
Automatically generate comprehensive API documentation from source code, including endpoints, parameters, and response types.
Project README Creation
Create polished README files with getting-started guides, installation instructions, and contribution guidelines.
Code Comment Enhancement
Add or improve inline code comments and docstrings to improve code readability and maintainability.
試試這些提示
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.
最佳實務
- Provide clear, specific instructions about the documentation format and structure desired
- Include existing documentation or code context when asking for updates
- Review generated documentation for technical accuracy before publishing
- Use consistent formatting and style guidelines across documentation
避免
- Asking for documentation without providing source code or context
- Expecting the skill to understand runtime behavior without execution
- Relying solely on generated docs without manual technical review
- Generating documentation for code with no comments or structure