Créateur de Référence API
Automatise la création de documentation de référence API avec génération de code et validation selon les meilleures pratiques de documentation technique.
name: "api-reference-creator" description: | Create api reference creator operations. Auto-activating skill for Technical Documentation. Triggers on: api reference creator, api reference creator Part of the Technical Documentation skill category. Use when working with APIs or building integrations. Trigger with phrases like "api reference creator", "api creator", "api". allowed-tools: "Read, Write, Edit, Bash(cmd:*), Grep" version: 1.0.0 license: MIT author: "Jeremy Longshore jeremy@intentsolutions.io"
Api Reference Creator
Overview
This skill provides automated assistance for api reference creator tasks within the Technical Documentation domain.
When to Use
This skill activates automatically when you:
- Mention "api reference creator" in your request
- Ask about api reference creator patterns or best practices
- Need help with technical documentation skills covering api docs, user guides, architecture docs, and documentation automation.
Instructions
- Provides step-by-step guidance for api reference creator
- Follows industry best practices and patterns
- Generates production-ready code and configurations
- Validates outputs against common standards
Examples
Example: Basic Usage Request: "Help me with api reference creator" Result: Provides step-by-step guidance and generates appropriate configurations
Prerequisites
- Relevant development environment configured
- Access to necessary tools and services
- Basic understanding of technical documentation concepts
Output
- Generated configurations and code
- Best practice recommendations
- Validation results
Error Handling
| Error | Cause | Solution | |-------|-------|----------| | Configuration invalid | Missing required fields | Check documentation for required parameters | | Tool not found | Dependency not installed | Install required tools per prerequisites | | Permission denied | Insufficient access | Verify credentials and permissions |
Resources
- Official documentation for related tools
- Best practices guides
- Community examples and tutorials
Related Skills
Part of the Technical Documentation skill category. Tags: documentation, markdown, api-docs, readme, technical-writing
Skills similaires
Generateur de Documentation API
Genere automatiquement de la documentation API OpenAPI/Swagger.
Rédacteur Technique
Rédige de la documentation technique claire selon les meilleurs style guides.