Glossario - Topic, task, single sourcing, conditional processing, information transclusion, DITA...

postato da Petra Dal Santo - KEA s.r.l. [09/08/2013 10:08]
foto

Una breve guida ai principali termini anglofoni del technical writing, esposti in ordine logico   

Topic

Il topic è un brano, che illustra all'utente un task, un concept o una reference: 

  • Task topic: descrive un task (compito) e i relativi step (passaggi), ovvero la procedura che l'utente deve seguire per raggiungere un goal, cioè un obiettivo reale che l'utente ha nell'utilizzo di un prodotto
  • Concept topic: definisce un concetto a supporto della descrizione di un task
  • Reference topic: è dedicato a contenuti di tipo enciclopedico (per esempio un lista di componenti, di comandi, ecc.). 

Ogni topic è dedicato a un solo argomento e redatto in modo tale da poter esistere come contenuto stand-alone (deve quindi essere di senso compiuto), ma da risultare anche componibile con altri topic per creare un flusso logico di informazioni.

Chunking

Frammentazione dei contenuti in topic riusabili all'interno dei vari tipi di documentazione tecnica (manuali, help online, tutorial, ecc.), rivolti ai vari tipi di destinatari (installatori, utilizzatori, manutentori, ecc.) e pubblicati attraverso i vari canali (carta, web, app, ecc.).

Frammentazione dei contenuti

Vd. Chunking

Topic-oriented writing

Il topic-oriented writing è una metodologia di technical writing incentrata sulla redazione dei contenuti della documentazione tecnica sotto forma di topic. Vd. Topic

Task-oriented writing

Il task-oriented writing focalizza i contenuti non sulle funzioni del prodotto, ma sugli obiettivi reali che i vari tipi di utente hanno nei confronti del prodotto, nonché sulle procedure che essi devono seguire per raggiungerli.

Minimalistic writing

Il minimalistic writing è una metodica di scrittura volta a fornire solo le informazioni che servono, quando servono, in base al tipo di utente, al suo livello e al contesto in cui opera.

Single sourcing

Per rendere efficiente il processo di redazione, aggiornamento e traduzione/localizzazione, i contenuti sono gestiti in modo univoco, cioè una sola volta, per essere poi riusati nei vari tipi di documentazione tecnica, rivolti ai vari tipi di destinatari e pubblicati attraverso i vari canali.

Tag, tagging

Marcare i contenuti con attributi e valori è fondamentale per definirne il contesto di riuso. Attributi e valori possono riferirsi, per esempio, ai destinatari della documentazione tecnica, alle procedure, ai tipi di prodotto, ecc.

Conditional processing

Applicando elaborazioni condizionali agli attributi e ai valori utilizzati per il tagging, è possibile includere o escludere automaticamente un contenuto in o da una pubblicazione, rivolta a un determinato destinatario e veicolata attraverso un determinato canale.

Information transclusion

Per trasclusione si intende la creazione di istanze di un contenuto, cioè l'inclusione mediante link di un documento o di parte di esso in un altro documento.

DITA (Darwin Information Typing Architecture)

DITA è uno standard definito e gestito dall'OASIS DITA Technical Committee.
Si tratta di una metodologia di editing in formato XML (semantico) e di publishing multicanale (mediante il DITA Open Toolkit) a supporto della redazione e della pubblicazione di documentazione tecnica basata sui principi del task-oriented writing e del minimalistic writing.

DITA standardizza in particolare: 

  • La redazione di topic
  • La struttura di navigazione dei contenuti
  • I link fra contenuti
  • La marcatura dei contenuti
  • Il conditional processing
  • Il riuso dei contenuti
  • La pubblicazione automatizzata dei contenuti, in particolare in formato PDF e HTML.