Guidelines for Writing English Language ...

Guidelines for Writing English Language Technical Documentation for an International Audience

Una linea guida della INTECOM per tutti i technical writer, che scrivono in lingua inglese senza avere l'inglese come madrelingua.

La guida ha 40 pagine e contiene un glossario con le specifiche per l'inglese britannico, quello statunitense e le raccomandazioni per l'inglese internazionale.

La linea guida è stata pubblicata dalla INTECOM (the International Council for Technical Communication) ed è da scaricare liberamente.

Lo standard contro la creatività

Da poco più di una settimana contribuisco al controllo qualità della manualistica di una software house.
Dopo una loro riorganizzazione tutti i project-manager dei moduli di software si occupano anche della scrittura dei manuali e help in linea.
I technical writer invece svolgono il coordinamento e la pubblicazione dei documenti.

La produzione dei documenti segue le stesse procedure dei prodotti software. Quindi usano gli stessi strumenti:

• Un sistema per gestire le release
• un quality center per gestire i bug ecc
  

I project manager sono circa 30 persone.

Com'è possibile che i documenti di 30 autori sono coerenti tra di loro?

I passi principali dell'azienda erano:

• introduzione del Information Mapping : (un metodo per la stesura strutturata e standardizzata)
• introduzione di un XML-editor con template personalizzate
• una serie di seminari formativi
  

Ancora è presto per me per dare un parere sulla effettiva coerenza che comprende molti aspetti:

• terminologia
• contenuto
• lingua
• layout
• illustrazioni
  

Una cosa è certa:

Allineare 30 technical writer è uno sforzo grosso.
Ma figuriamoci lo sforzo di allineare 30 autori, che non hanno imparato il mestiere del technical writer ma tutt'altro: dal programmatore al venditore di software.

Per approfondire:

• "Standardisierung versus Kreativität" congresso primaverile della tekom; 3-4 aprile D-Friedrichshafen; lago di Costanza. Tutti i discorsi e dibattiti sono in lingua tedesca.
• sito dell'Information Mapping