Leggere in inglese

Condividi tramite


Guida introduttiva a stile e voce di Microsoft Learn

Questa guida introduttiva è una breve guida alla scrittura di contenuto tecnico per la pubblicazione in Microsoft Learn. Queste linee guida sono valide sia per la creazione di nuova documentazione che per l'aggiornamento di documentazione esistente.

Procedure consigliate:

  • Controllare l'ortografia e la grammatica degli articoli, anche se per eseguire il controllo è necessario copiarli e incollarli in Microsoft Word.
  • Usare un tono informale e discorsivo.
  • Usare frasi semplici. Frasi semplici da leggere significano che il lettore può mettere in pratica velocemente le indicazioni condivise.

Rispettare i principi per tono e voce Microsoft

Aspiramo a seguire questi principi quando scriviamo contenuti tecnici per Microsoft Learn. Non sempre è possibile, ma è importante tenere presente questo obiettivo.

  • Concentrarsi sugli scopi: i clienti hanno scopi specifici quando decidono di consultare la documentazione Microsoft. Prima di iniziare a scrivere, stabilire con chiarezza la tipologia di clienti ai quali ci si rivolge e quali sono le attività di loro interesse. Scrivere quindi l'articolo con l'obiettivo di aiutare clienti specifici a eseguire attività specifiche.
  • Usare parole comuni: usare un linguaggio naturale, le parole che normalmente i clienti usano. Il linguaggio deve essere meno formale ma non meno tecnico. Offrire esempi che illustrano i concetti nuovi.
  • Scrivere in modo conciso: evitare di sprecare le parole. Essere affermativi e non usare parole superflue o molti qualificativi. Mantenere le frasi brevi e sintetiche. Rimanere in tema con l'articolo. Se per un'attività esiste un qualificativo, aggiungerlo all'inizio della frase o del paragrafo. Limitare al massimo il numero di note. Usare uno screenshot quando è utile per risparmiare parole.
  • Agevolare la lettura dell'articolo: aggiungere gli elementi più importanti all'inizio. Usare le sezioni per suddividere le procedure lunghe in gruppi di passaggi più gestibili. Le procedure con più di 12 passaggi sono probabilmente troppo lunghe. Usare uno screenshot quando aggiunge chiarezza.
  • Dimostrare empatia: usare un tono collaborativo nell'articolo, riducendo al minimo le dichiarazioni di non responsabilità. Segnalare con franchezza le aree che potrebbero essere frustranti per i clienti. Assicurarsi che l'articolo sia incentrato sulle informazioni effettivamente utili per il cliente, evitando che si trasformi in una conferenza tecnica.

Tenere conto di localizzazione e traduzione automatica

Gli articoli tecnici di Microsoft vengono tradotti in varie lingue e alcuni adattati a mercati o aree geografiche particolari. È anche possibile che gli utenti usino la traduzione automatica sul Web per leggere gli articoli tecnici. Quindi, tenere presenti queste linee guida durante la scrittura:

  • Assicurarsi che l'articolo non contenga errori di grammatica, ortografia o punteggiatura: questo è un controllo da eseguire sempre. Alcuni editor di Markdown, come ad esempio MarkdownPad 2.0, includono un semplice correttore ortografico, ma è buona norma incollare il contenuto HTML dopo il rendering dall'articolo in Word, che include un correttore ortografico e grammaticale più avanzato.
  • Scrivere frasi il più possibile brevi: le frasi composte o le proposizioni concatenate rendono difficile la traduzione. Suddividere le frasi se è possibile farlo senza che l'esposizione diventi ridondante o risulti strana. È importante evitare di scrivere gli articoli con un linguaggio innaturale.
  • Usare costruzioni semplici e coerenti per le frasi: la coerenza è un vantaggio per la traduzione. Evitare parentesi e incisi e fare in modo che il soggetto sia il più possibile vicino all'inizio della frase. Leggere prima alcuni articoli già pubblicati. Se un articolo ha uno stile personale, facile da leggere, usarlo come modello.
  • Usare terminologia e combinazioni di maiuscole/minuscole coerenti: ancora una volta la coerenza è importante. Non usare la lettera maiuscola a meno che la parola non sia all'inizio della frase o sia un nome proprio.
  • Includere articoli, preposizioni e congiunzioni: alcune parole sono considerate poco importanti perché implicite o deducibili facilmente dal contesto, come gli articoli e le preposizioni, ma sono fondamentali per la traduzione automatica. Assicurarsi di includerle.

Altri aspetti relativi a stile e voce di cui tenere conto

  • Non interrompere una sequenza di passaggi con commenti o digressioni.
  • Per i passaggi che includono frammenti di codice, inserire le informazioni aggiuntive sul passaggio nel codice in forma di commenti. In questo modo si riduce la quantità di testo che gli utenti dovranno leggere con attenzione. Le informazioni cruciali vengono copiate nel progetto del codice per ricordare al lettore quali sono gli scopi del codice in qualsiasi momento.
  • Nei titoli e nelle intestazioni usare la lettera maiuscola solo per la prima parola.
  • Usare "accesso" e non "login".
  • Per altre linee guida, vedere la Microsoft Writing Style Guide (Guida di stile per la redazione Microsoft).

Documentazione localizzata

  • Se si contribuisce alla documentazione localizzata, fare riferimento ai riferimenti alla globalizzazione.
  • Per linee guida sulla localizzazione, indicazioni sullo stile e l'uso della lingua nelle pubblicazioni tecniche e informazioni sui formati di dati specifici per i diversi mercati, scaricare la guida di stile per la lingua in questione.
  • Visitare Terminologia Microsoft per cercare terminologia approvata specifica del prodotto o scaricare la raccolta terminologia Microsoft nella lingua in uso.
  • Per altre informazioni sulla localizzazione, vedere "Global communications" (Comunicazioni globali) nella Microsoft Writing Style Guide (Guida di stile per la redazione Microsoft).

Nota

La maggior parte della documentazione localizzata non offre la possibilità di modificare o fornire commenti e suggerimenti tramite GitHub. Per fornire commenti e suggerimenti sul contenuto localizzato, usare il https://aka.ms/provide-feedback modulo.