Word GRATIS

Template per Guida di Stile del Codice in Word

Allinea il team su uno standard di codice condiviso: una guida di stile completa con convenzioni, esempi corretti e sbagliati affiancati, regole di review e checklist, pronta in Word.

In sintesi

Template per Guida di Stile del Codice in Word è un template in formato Word pubblicato da Management Academy. Prompt avanzato in italiano per una coding style guide completa: naming, struttura, errori, test, esempi DO/DON'T e checklist di code review, in Word. Si scarica gratuitamente con un account gratuito.

a cura della faculty di Management Academy

Cos'è e quando si usa

Allinea il team su uno standard di codice condiviso: una guida di stile completa con convenzioni, esempi corretti e sbagliati affiancati, regole di review e checklist, pronta in Word.

Cosa contiene il file

# Guida di stile del codice — [linguaggio/stack]

## 1. Principi
- Leggibilità prima di brillantezza
- Coerenza con la codebase esistente prima delle preferenze personali

## 2. Naming
| Elemento | Convenzione | Esempio |
|---|---|---|
| Variabili | camelCase, descrittive | userCount |
| Costanti | UPPER_SNAKE | MAX_RETRIES |
| Funzioni | verbo + oggetto | fetchInvoices() |

### DO / DON'T
DO:
```
const activeUsers = users.filter(u => u.isActive);
```
DON'T:
```
const a = users.filter(u => u.x); // nomi opachi
```
Perché: i nomi opachi costringono a leggere l'implementazione per capire l'intento.

## 3. Struttura dei file
- Un componente per file; export nominati preferiti agli export default.

## 4. Gestione degli errori
| Regola | Automatizzabile dal linter |
|---|---|
| Mai catturare errori in silenzio | Parziale |
| Errori tipizzati, non stringhe | Sì |

## 5. Test
- Nome test: 'descrive comportamento, non implementazione'
- Copertura minima per modulo critico: [valore da decidere col team]

## 6. Checklist di code review
- [ ] Nomi chiari e coerenti
- [ ] Nessun TODO senza ticket
- [ ] Test per il nuovo comportamento
- [ ] Gestione errori esplicita

Come si usa, passo per passo

  1. Scarica il file e aprilo. Resta editabile: si apre con Excel, Word e PowerPoint, e anche con Google Workspace o LibreOffice.
  2. Compila prima le sezioni obbligatorie. Sono quelle che un committente o un esaminatore guarda per prime: oggetto, responsabili, criteri di accettazione.
  3. Rigenera con il prompt sui tuoi dati. Copia il prompt di questa pagina, incolla il contesto del progetto e ottieni il documento già compilato.
  4. Fai rivedere il risultato. Un documento corretto nel metodo ma scollegato dal progetto non regge alla prima domanda: rileggilo con chi il progetto lo conosce.

Domande frequenti

Si adatta al mio linguaggio e framework?

Sì. Indichi linguaggio, framework e linter già in uso, e il prompt genera convenzioni concrete e idiomatiche per quello stack, non regole generiche. Gli esempi DO/DON'T sono scritti nella sintassi del tuo linguaggio.

Include esempi di codice corretto e sbagliato?

Sì, ogni regola importante ha una coppia DO/DON'T affiancata con una breve spiegazione del perché. Sono il cuore della guida: rendono le convenzioni inequivocabili e riducono le discussioni soggettive in code review.

Posso usarla come base per le regole del linter?

Sì. La guida marca quali regole sono automatizzabili dal linter/formatter e quali richiedono giudizio umano in review, così sai cosa puoi far rispettare in CI e cosa resta responsabilità del reviewer.