Risorse di scrittura tecnica

Questa pagina riassume ulteriori risorse di scrittura tecnica.

Guide di stile editoriale

Una guida di stile editoriale definisce le linee guida di un gruppo editoriale per la comunicazione. Per esempio, quale delle seguenti regole dovrebbe adottare la vostra organizzazione per i titoli?

• Mettere i titoli in caso di frase (mettere in maiuscolo solo la prima parola di ogni titolo)
• Mettere i titoli in caso di titolo (mettere in maiuscolo la maggior parte delle parole in ogni titolo)

Non perdete tempo ed energia a discutere su questo tipo di domande.Invece, chiedete semplicemente alla vostra organizzazione di adottare una particolare guida di stile editoriale.Una guida di stile editoriale fornisce una serie di risposte alle domande sulle scelte di scrittura. Non importa che una guida di stile editoriale sostenga il caso della frase e un’altra preferisca il caso del titolo. Importa solo che la vostra organizzazione adotti un’unica guida di stile editoriale.

Ah, ma quale guida di stile editoriale? Potreste già avere familiarità con le guide di stile editoriale di uso generale (come il Chicago Manual ofStyle o laUniversity of Oxford StyleGuide).Tuttavia, il vostro team di ingegneri dovrebbe usare una guida di stile editoriale specializzata nella scrittura tecnica. Consigliamo di scegliere una delle seguenti:

• La guida di stile della documentazione per sviluppatori di Google fornisce linee guida editoriali per chiunque scriva documentazione per sviluppatori per progetti legati a Google.
• La guida di stile di scrittura Microsoft fornisce linee guida per chiunque scriva documentazione tecnica.

Non scrivere la tua guida di stile editoriale. Creare e mantenere una guida di stile editoriale “domestica” richiede enormi risorse e causa tremendi conflitti. Detto questo, alcune organizzazioni coniano una nuova terminologia che non compare in una guida di stile editoriale esistente. Quando ciò accade, l’organizzazione può fare una delle seguenti cose:

• Chiedere ai manutentori di una guida di stile editoriale di aggiungere i nuovi termini.
• Creare e mantenere la propria guida d’uso o foglio di stile che codifica le ortografie e gli usi delle parole per il vocabolario specializzato della propria organizzazione.

Opportunità di documentazione open-source