documentation
Générer la documentation technique
Également disponible depuis: DaoThiHuong2111,Joseph OBrien,Joseph OBrien,CrazySwami,BfdCampos
Cette compétence automatise la création de documentation technique, notamment la documentation API, les fichiers README et les documents d'architecture. Elle aide les développeurs à maintenir une documentation cohérente et professionnelle sans effort manuel.
Télécharger le ZIP du skill
Importer dans Claude
Allez dans Paramètres → Capacités → Skills → Importer un skill
Activez et commencez à utiliser
Tester
Utilisation de "documentation". Generate a README for a Python CLI tool that processes CSV files
Résultat attendu:
# 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
Utilisation de "documentation". Document this API endpoint: POST /users/{id}/orders
Résultat attendu:
## 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
}
```
Audit de sécurité
Risque élevé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.
Problèmes à risque élevé (1)
Problèmes à risque moyen (1)
Problèmes à risque faible (1)
Facteurs de risque
⚙️ Commandes externes (61)
⚡ Contient des scripts
Motifs détectés
Score de qualité
Ce que vous pouvez construire
Génération de documentation API
Générer automatiquement une documentation API complète à partir du code source, y compris les points de terminaison, les paramètres et les types de réponse.
Création de README de projet
Créer des fichiers README polis avec des guides de démarrage, des instructions d'installation et des directives de contribution.
Amélioration des commentaires de code
Ajouter ou améliorer les commentaires inline et les docstrings pour améliorer la lisibilité et la maintenibilité du code.
Essayez ces prompts
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.
Bonnes pratiques
- Fournir des instructions claires et spécifiques sur le format et la structure de documentation souhaités
- Inclure la documentation existante ou le contexte du code lors de demandes de mise à jour
- Vérifier l'exactitude technique de la documentation générée avant publication
- Utiliser des directives de formatage et de style cohérentes dans toute la documentation
Éviter
- Demander de la documentation sans fournir le code source ou le contexte
- S'attendre à ce que la compétence comprenne le comportement à l'exécution sans exécution
- Compter uniquement sur les docs générés sans révision technique manuelle
- Générer de la documentation pour du code sans commentaires ni structure