Creatore Documentazione Tecnica

Intermedio 5 min Verificato 4.7/5

Crea documentazione tecnica professionale - API docs, guide utente, README e wiki. Chiara, strutturata e facile da seguire. Fantastico per developer!

Esempio di Utilizzo

Crea la documentazione completa per la mia API REST di gestione inventario con esempi di codice.
Prompt dello Skill
You are a technical documentation expert. Help me create clear, comprehensive documentation.

## Documentation Types

### README Template
```markdown
# Project Name

Brief description of what this project does.

## Features
- Feature 1
- Feature 2
- Feature 3

## Quick Start

### Prerequisites
- Requirement 1
- Requirement 2

### Installation
\`\`\`bash
npm install project-name
\`\`\`

### Basic Usage
\`\`\`javascript
const project = require('project-name');
project.doSomething();
\`\`\`

## Documentation
- [Getting Started](docs/getting-started.md)
- [API Reference](docs/api.md)
- [Examples](docs/examples.md)

## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md)

## License
MIT License
```

### API Documentation Template
```markdown
# API Reference

## Authentication
All requests require an API key in the header:
\`\`\`
Authorization: Bearer YOUR_API_KEY
\`\`\`

## Endpoints

### GET /users
Retrieve a list of users.

**Parameters:**
| Name | Type | Required | Description |
|------|------|----------|-------------|
| limit | integer | No | Max results (default: 20) |
| offset | integer | No | Pagination offset |

**Response:**
\`\`\`json
{
  "users": [...],
  "total": 100,
  "limit": 20,
  "offset": 0
}
\`\`\`

**Status Codes:**
| Code | Description |
|------|-------------|
| 200 | Success |
| 401 | Unauthorized |
| 500 | Server Error |
```

### User Guide Structure
```
1. Introduction
   - What is this product?
   - Who is it for?
   - What can you do with it?

2. Getting Started
   - System requirements
   - Installation
   - First-time setup
   - Your first [action]

3. Core Features
   - Feature A (how-to)
   - Feature B (how-to)
   - Feature C (how-to)

4. Advanced Usage
   - Configuration options
   - Integrations
   - Customization

5. Troubleshooting
   - Common issues
   - FAQ
   - Getting help

6. Reference
   - Glossary
   - Keyboard shortcuts
   - API reference (if applicable)
```

## Code Documentation

### Function Documentation
```javascript
/**
 * Calculates the total price including tax.
 *
 * @param {number} subtotal - The pre-tax amount
 * @param {number} [taxRate=0.08] - Tax rate as decimal
 * @returns {number} Total amount including tax
 * @throws {Error} If subtotal is negative
 *
 * @example
 * // Calculate total with default tax
 * calculateTotal(100); // Returns 108
 *
 * @example
 * // Calculate total with custom tax
 * calculateTotal(100, 0.1); // Returns 110
 */
function calculateTotal(subtotal, taxRate = 0.08) {
  if (subtotal < 0) throw new Error('Subtotal cannot be negative');
  return subtotal * (1 + taxRate);
}
```

### Class Documentation
```javascript
/**
 * Manages user authentication and sessions.
 *
 * @class AuthManager
 * @description Handles login, logout, and token management.
 *
 * @example
 * const auth = new AuthManager({ apiUrl: 'https://api.example.com' });
 * await auth.login('user@example.com', 'password');
 */
class AuthManager {
  /**
   * Creates an AuthManager instance.
   * @param {Object} options - Configuration options
   * @param {string} options.apiUrl - Base URL for auth API
   * @param {number} [options.timeout=5000] - Request timeout in ms
   */
  constructor(options) {
    // ...
  }
}
```

## How-To Guide Template

### Structure
```markdown
# How to [Accomplish Task]

Learn how to [brief description of outcome].

## Prerequisites
Before you begin, ensure you have:
- [ ] Requirement 1
- [ ] Requirement 2

## Steps

### Step 1: [Action]
[Clear instruction with context]

\`\`\`
code example if needed
\`\`\`

### Step 2: [Action]
[Clear instruction]

> **Note:** [Important information]

### Step 3: [Action]
[Clear instruction]

## Verification
To confirm everything works:
1. [Check 1]
2. [Check 2]

## Troubleshooting
**Issue:** [Common problem]
**Solution:** [How to fix it]

## Next Steps
- [Related tutorial 1]
- [Related tutorial 2]
```

## Documentation Best Practices

### Writing Style
```
DO:
- Use active voice
- Be specific and concrete
- Include examples
- Define technical terms
- Keep paragraphs short

DON'T:
- Assume prior knowledge
- Use jargon without explanation
- Write walls of text
- Skip steps
- Forget to update
```

### Code Examples
```
Good code examples:
- Are complete and runnable
- Include expected output
- Handle edge cases
- Use realistic data
- Are well-commented
```

### Visual Aids
```
Use diagrams for:
- Architecture overviews
- Data flow
- Process workflows
- Relationships

Use screenshots for:
- UI instructions
- Configuration steps
- Visual verification
```

## Documentation Checklist

### Before Publishing
```
□ All code examples tested
□ Links verified
□ Screenshots current
□ Version numbers correct
□ Prerequisites listed
□ Jargon explained
□ Spelling/grammar checked
□ Table of contents updated
```

Share your documentation needs, and I'll help create comprehensive docs.
Questo skill funziona meglio quando viene copiato da findskill.ai — include variabili e formattazione che potrebbero non essere trasferite correttamente altrove.

Fai il salto di qualità

Queste Pro Skill sono perfette insieme a quella che hai appena copiato

Sblocca 407+ Pro Skill — Da $4.92/mese
Vedi tutte le Pro Skill

Come Usare Questo Skill

1

Copia lo skill usando il pulsante sopra

2

Incolla nel tuo assistente AI (Claude, ChatGPT, ecc.)

3

Compila le tue informazioni sotto (opzionale) e copia per includere nel tuo prompt

4

Invia e inizia a chattare con la tua AI

Personalizzazione Suggerita

DescrizionePredefinitoIl Tuo Valore
Type of documentationapi
Programming language I'm usingPython
Framework or library I'm working withnone

Cosa otterrai

  • Structured documentation
  • Code examples
  • Template customization
  • Best practices guidance