0Pricing
Frontend Academy · Lezione

Mentoring e documentazione tecnica

Far crescere i membri junior del team attraverso il pair programming e feedback tempestivi, scrivere ADR per le decisioni architetturali e mantenere una documentazione aggiornata di cui gli altri si fidino

Mentoring e documentazione tecnica è una lezione Frontend Academy gratuita su CoddyKit. Questa è la lezione 3 di 4. Puoi leggere la lezione completa qui gratuitamente — poi esercitati direttamente nel browser con un editor di codice integrato e un tutor IA disponibile 24/7. Fa parte del percorso di apprendimento Frontend Academy, e i tuoi progressi si sincronizzano tra il web e l'app CoddyKit. Il corso Frontend Academy include 4 lezioni in totale.

Essere senior significa far crescere gli altri

A livello senior, il Suo compito non è scrivere più codice di tutti, ma rendere migliore il team. Affianchi gli sviluppatori junior, scriva documentazione che amplifichi la Sua conoscenza, svolga revisioni del codice che insegnino e contribuisca a definire l'architettura affinché gli altri possano procedere rapidamente e in sicurezza.

Fare mentoring con il pair programming

Il pair programming è il modo più rapido per far crescere uno sviluppatore junior. Lavorate insieme (oppure condivida lo schermo), lasci che sia il junior a guidare mentre Lei fa da navigatore. Resista alla tentazione di prendere il controllo: spieghi il Suo ragionamento e ponga domande socratiche.

Sfide della giusta difficoltà

Affidi agli sviluppatori junior attività appena al di sopra delle loro capacità attuali. Troppo facili = nessuna crescita. Troppo difficili = difficoltà insostenibili e frustrazione. Valuti la situazione: 'Penso che possa farcela con un po' di aiuto; se si blocca, sarò lieto di lavorare in pair programming.'

La revisione del codice come insegnamento

Per le PR degli sviluppatori junior, spieghi il motivo alla base di ogni commento non banale. Inserisca link a documentazione pertinente, PR precedenti o articoli. Cattiva revisione: 'usi useCallback'. Buona revisione: 'Questa funzione viene ricreata a ogni render: passarla a un componente figlio memoizzato causa re-render non necessari. useCallback la memoizza. Ecco una PR di esempio in cui lo abbiamo fatto: #1234'.

Architectural Decision Record (ADR)

Un ADR documenta una scelta architetturale significativa: che cosa abbiamo deciso, perché, quali alternative abbiamo considerato e quali compromessi abbiamo accettato. Il Suo io futuro ringrazierà il Suo io presente.

# ADR-0007: Use TanStack Query for server state

Date: 2026-05-01
Status: Accepted

## Context
We currently scatter useEffect+fetch+useState patterns across the app.
Cache invalidation is inconsistent, race conditions cause stale data.

## Decision
Adopt TanStack Query (@tanstack/react-query v5) for all server state.

## Consequences
+ Built-in caching, deduplication, optimistic updates.
+ Standard pattern across team.
- Adds ~13KB gzipped.
- Team needs to learn query keys conventions.

## Alternatives Considered
- SWR: smaller, but fewer features (no mutations).
- Apollo Client: overkill (we don't use GraphQL).
- Custom hook: doesn't solve cache invalidation.

## References
- React Query docs: ...

Dove conservare gli ADR

Conservi gli ADR in docs/adr/ nel repository, numerandoli in sequenza. Devono stare accanto al codice che descrivono. Strumenti: adr-tools e log4brains per un'interfaccia web consultabile.

Qualità del README

Ogni package, libreria e funzionalità principale ha bisogno di un README. Includa: che cosa fa, come installarlo, come usarlo (con esempi di codice), come contribuire, come eseguire i test e come eseguire il debug. Sviluppo guidato dal README: scriva prima il README, poi costruisca il prodotto seguendo quella specifica.

Commenti inline nel codice: quando usarli

I commenti devono spiegare perché, non che cosa. Il codice mostra che cosa accade. I commenti spiegano: regole di business, compromessi non ovvi, link a ticket o bug e avvertenze sulle possibili insidie.

// BAD: comment restates the code
// Increment counter by 1
counter++;

// GOOD: comment explains business context
// Stripe webhook can arrive twice — increment only if signature is fresh.
// See: https://stripe.com/docs/webhooks/best-practices#idempotency
if (!seen.has(event.id)) counter++;

Runbook per le attività operative

Documenti come eseguire le attività operative ricorrenti o rischiose: 'Come ruotare la chiave API di Stripe', 'Come ripristinare il servizio dopo un deploy non riuscito', 'Come eseguire il debug di una risposta API lenta'. I nuovi membri del team potranno seguire la procedura senza dover chiedere il Suo intervento.

Documentazione viva

La documentazione obsoleta è peggiore dell'assenza di documentazione. Indichi la data. La riveda ogni trimestre. Elimini i documenti che nessuno aggiorna. Meglio ancora: generi la documentazione dal codice (Storybook per i componenti, TypeDoc per le API, OpenAPI per gli endpoint).

Tech talk e brown-bag

Tenga talk di 20-30 minuti per il team su ciò che ha imparato: una nuova libreria, un'esperienza di debug o un pattern che ha trovato utile. Questo La costringe a organizzare il Suo pensiero e insegna agli altri.

Costruire la sicurezza psicologica

I junior che hanno paura di fare domande non crescono. Renda normale dire 'non lo so'. Crei un ambiente in cui sia sicuro commettere errori: valorizzi il post-mortem, non la ricerca del colpevole. In qualità di senior, le Sue reazioni definiscono il tono del team.

La trappola della programmazione eroica

Non sia la persona che risolve da sola ogni incidente in produzione. Documenti la correzione, lavori in pair programming con un collega la volta successiva e automatizzi la diagnosi. Un team che ha bisogno dei Suoi interventi eroici è fragile.

Verifica rapida

Qual è lo scopo principale di un Architectural Decision Record (ADR)?

Riepilogo: mentoring e documentazione

Senior significa far crescere gli altri, non scrivere più codice di tutti. Faccia pair programming; insegni attraverso la revisione del codice; assegni sfide della giusta difficoltà. Gli ADR in docs/adr/ registrano il motivo delle decisioni. Predisponga un README per ogni package. I commenti spiegano perché, non che cosa. Usi i runbook per le attività operative. La documentazione viva (Storybook, TypeDoc, OpenAPI) è migliore del markdown statico. Costruisca la sicurezza psicologica. Eviti la programmazione eroica.

Domande Frequenti

La lezione «Mentoring e documentazione tecnica» è gratuita?

Sì — il testo completo di «Mentoring e documentazione tecnica» è gratuito qui sul web. Per esercitarvi in modo interattivo (un editor di codice integrato e un tutor IA 24/7) e sbloccare il resto del corso Frontend Academy, passa a CoddyKit PRO. Il corso Frontend Academy include 4 lezioni in totale.

Cosa imparerò in «Mentoring e documentazione tecnica»?

Far crescere i membri junior del team attraverso il pair programming e feedback tempestivi, scrivere ADR per le decisioni architetturali e mantenere una documentazione aggiornata di cui gli altri si… Eserciti Frontend Academy con codice pratico che esegui direttamente nel browser, e un tutor IA 24/7 risponde alle tue domande mentre lavori sulla lezione.

Ho bisogno di esperienza per iniziare Frontend Academy?

Non è richiesta alcuna esperienza precedente. Frontend Academy su CoddyKit è strutturato per principianti e studenti avanzati, quindi puoi iniziare da qui o dall'inizio e procedere al tuo ritmo. Questa è la lezione 3 di 4.

Quanto tempo richiede la lezione «Mentoring e documentazione tecnica»?

La maggior parte delle lezioni CoddyKit richiede circa 5–10 minuti. Ogni lezione è breve e interattiva, quindi fai progressi costanti e riprendi esattamente da dove hai lasciato su web e app.

Posso scrivere ed eseguire codice in questa lezione Frontend Academy?

Sì. Ogni lezione Frontend Academy include un editor di codice integrato, quindi scrivi ed esegui codice reale direttamente nel tuo browser e ricevi feedback istantaneo dall'IA — nessuna configurazione locale necessaria.

Tutte le lezioni di questo corso

  1. Colloqui di system design frontend
  2. Cultura del code review e buone pratiche per le PR
  3. Mentoring e documentazione tecnica
  4. Rimanere aggiornati: leggere specifiche e proposte
← Torna a Frontend Academy