Dal "monolite" ai "moduli" ovvero come definisco i miei Topic: seconda parte

Il Topic è un segmento di contenuto autosufficiente, tale da poter essere aggregato ad altri topic per dare vita a contenuti più articolati.

Le dimensioni o "granularità" di un Topic sono molto variabili: potrebbe essere un intero capitolo, un singolo paragrafo, una tabella o un frammento di testo anche di poche righe.

Il dimensionamento di un Topic può dipendere da diversi aspetti.

In generale, un Topic dovrebbe essere caratterizzato da almeno una (o più) delle seguenti proprietà:

• chiusura rispetto ad un preciso tema
• potenziale riuso
• appartenenza ad una classe generale
• derivare dalla composizione di Topic "chiusi"

Un Topic è "chiuso" se può essere considerato a se stante, singolarmente, ed è in grado di esprimere compiutamente il senso del proprio contenuto.

TOPIC A

 

Se questa sequenza operativa è riutilizzabile anche in altri contesti, il Topic oltre ad essere "chiuso" è "riusabile", quindi possiede 2 delle 3 proprietà sopracitate.

TOPIC B

 

Questo Topic è chiuso ma potrebbe essere spezzato in due Topic di granularità minore, entrambi chiusi. In generale, è sempre opportuno ridurre al minimo possibile la granularità.

TOPIC C

Questo Topic non è "chiuso", perchè fa riferimento al concetto di Accounts, non espresso esplicitamente nel TOPIC C. In generale, sarà possibile esprimere una o più RELAZIONI tra un certo Topic ed altri Topic.

TOPIC D

Questo Topic potrebbe essere collocato nella "classe" dei Topic relativi alle "convenzioni redazionali" della documentazione aziendale. La classe di appartenenza di un Topic può essere definita in base a diversi criteri.

In generale, definiamo classe è un insieme omogeneo di elementi.

Per esempio in DITA distinguiamo tra 3 classi principali:

• Concept Topic (concetti)
• Reference Topic (ad esempio, una tabella)
• Task (ad esempio, la descrizione step-by-step di una certa operazione)

Esistono anche altre metodologie che ci suggeriscono classificazioni diverse, come Information Mapping, Functional Design o S1000D.

Come sempre, non esistono in assoluto metodologie migliori di altre, ma il punto da cogliere è che se operiamo una classificazione dobbiamo essere coerenti con la classificazione scelta, perchè da questa deriva una proprietà fondamentale nella definizione dei Topic sui quali poi costruiremo il nostro nuovo modo di produrre contenuti tecnici.

Nel prossimo post vedremo come:

• definire relazioni tra i Topic
• aggregare diverse tipologie di Topic per definire contenuti complessi in modo efficente

Condividi

Articoli correlati per categorie