Claude Code è uno strumento da riga di comando agentico che può aiutarti a gestire la documentazione. Può creare nuovi contenuti, revisionare le pagine esistenti e mantenerle aggiornate. Puoi istruire Claude Code a comprendere i tuoi standard e i tuoi flussi di lavoro di documentazione aggiungendo un file CLAUDE.md al progetto e perfezionandolo nel tempo.

​
Guida rapida

Prerequisiti:
  • Abbonamento attivo a Claude (Pro, Max o accesso API)
Configurazione:
  1. Installa Claude Code:
  npm install -g @anthropic-ai/claude-code
  1. Vai alla directory della tua documentazione.
  2. (Opzionale) Aggiungi al progetto il file CLAUDE.md riportato di seguito.
  3. Esegui claude per iniziare.

​
Modello CLAUDE.md

Salva un file CLAUDE.md nella root della directory della documentazione per aiutare Claude Code a comprendere il tuo progetto. Questo file istruisce Claude Code sui tuoi standard di documentazione, preferenze e flussi di lavoro. Consulta Gestire la memoria di Claude nella documentazione di Anthropic per maggiori informazioni. Copia questo modello di esempio o adattalo alle specifiche della tua documentazione: 
# Documentazione Mintlify

## Relazione di lavoro
- Puoi mettere in discussione le idee: questo può portare a una documentazione migliore. Cita le fonti e spiega il ragionamento quando lo fai
- CHIEDI SEMPRE chiarimenti invece di fare supposizioni
- NON mentire, non indovinare e non inventare informazioni

## Contesto del progetto
- Formato: file MDX con frontmatter YAML
- Configurazione: docs.json per navigazione, tema e impostazioni
- Componenti: componenti Mintlify

## Strategia dei contenuti
- Documenta il minimo necessario per il successo dell’utente: né troppo né troppo poco
- Dai priorità ad accuratezza e usabilità delle informazioni
- Mantieni i contenuti sempreverdi quando possibile
- Cerca informazioni esistenti prima di aggiungerne di nuove. Evita duplicazioni a meno che non siano strategiche
- Verifica i pattern esistenti per coerenza
- Inizia apportando il minor cambiamento ragionevole

## docs.json

- Fai riferimento allo [schema di docs.json](https://mintlify.com/docs.json) quando costruisci il file docs.json e la navigazione del sito

## Requisiti di frontmatter per le pagine
- title: Titolo di pagina chiaro e descrittivo
- description: Sintesi concisa per SEO/navigazione

## Standard di scrittura
- Voce in seconda persona (“tu”)
- Prerequisiti all’inizio dei contenuti procedurali
- Testa tutti gli esempi di codice prima della pubblicazione
- Allinea stile e formattazione alle pagine esistenti
- Includi casi d’uso base e avanzati
- Tag di linguaggio su tutti i blocchi di codice
- Testo alternativo per tutte le immagini
- Percorsi relativi per i link interni

## Workflow Git
- NON usare --no-verify durante i commit
- Chiedi come gestire le modifiche non committate prima di iniziare
- Crea un nuovo branch quando non esiste un branch chiaro per le modifiche
- Effettua commit frequenti durante lo sviluppo
- NON saltare o disabilitare i pre-commit hook

## Da non fare
- Omettere il frontmatter in qualsiasi file MDX
- Usare URL assoluti per i link interni
- Includere esempi di codice non testati
- Fare supposizioni: chiedi sempre chiarimenti

​
Prompt di esempio

Una volta configurato Claude Code, prova questi prompt per vedere come può aiutarti con le attività comuni di documentazione. Puoi copiare e incollare direttamente questi esempi oppure adattarli alle tue esigenze specifiche.

​
Trasforma gli appunti in documentazione curata

Converti bozze grezze in pagine Markdown ben formattate, con componenti e frontmatter. Prompt di esempio: 
Convert this text into a properly formatted MDX page: [paste your text here]

​
Rivedi la documentazione per coerenza

Ottieni suggerimenti per migliorare lo stile, la formattazione e l’uso dei componenti. Prompt di esempio: 
Review the files in docs/ and suggest improvements for consistency and clarity

​
Aggiorna la documentazione quando le funzionalità cambiano

Mantieni la documentazione aggiornata man mano che il prodotto evolve. Prompt di esempio: 
La nostra API ora richiede un parametro di versione. Aggiorna la documentazione per includere version=2024-01 in tutti gli esempi

​
Genera esempi di codice completi

Crea esempi in più lingue con gestione degli errori. Prompt di esempio: 
Create code examples for [your API endpoint] in JavaScript, Python, and cURL with error handling

​
Estendere Claude Code

Oltre a fornire prompt manualmente a Claude Code, puoi integrarlo nei tuoi flussi di lavoro esistenti.

​
Automazione con GitHub Actions

Esegui automaticamente Claude Code quando il codice cambia per mantenere la documentazione aggiornata. Puoi avviare revisioni della documentazione sulle pull request oppure aggiornare gli esempi quando vengono rilevate modifiche all’API.

​
Flussi di lavoro multi‑istanza

Usa sessioni separate di Claude Code per attività diverse: una per scrivere nuovi contenuti e un’altra per la revisione e il controllo qualità. Questo aiuta a mantenere la coerenza e a individuare problemi che una singola sessione potrebbe non rilevare.

​
Collaborazione del team

Condividi il file CLAUDE.md raffinato con il tuo team per garantire standard di documentazione uniformi tra tutti i collaboratori. Spesso i team sviluppano prompt e flussi di lavoro specifici del progetto che diventano parte integrante del processo di documentazione.

​
Comandi personalizzati

Crea comandi slash riutilizzabili in .claude/commands/ per attività di documentazione frequenti, specifiche del tuo progetto o team.