Concetto di DCL

Premessa

La sigla dcl sta ad indicare la "classe del documento". Questa classe è analoga all'indice documento previsto dalle metodologie Method-1 ed mssi. Indica cioè il tipo di contenuto del documento. Ad esempio in mssi un documento data10 descrive un data base.

La definizione concreta delle diverse dcl si basa sul tipo di documentazione che è necessaria nella costruzione e manutenzione di un sistema informativo. Può essere inoltre funzione delle metodologie di analisi e di sviluppo e del tipo di sistema sviluppato.

I sistemi Method-1 e da mssi prevedevano centinaia di tipi documento. A mio avviso questo fatto era più legato al problema di documentare la metodologia che al problema di documentare il sistema. La metodologia, ad esempio, prevedeva che il prodotto dell'attività "enumerazione dei centri di calcolo" fosse un documento riguardante le "risorse disponibili" e cioè un documento ris. Ma nel manuale si voleva fornire un esempio concreto di tale documento per cui veniva definito il tipo documento "RIS311-Conteggio dei Centri di Calcolo". Da un canto il sistema soffre di un eccesso di precisione (come un piano dei conti troppo dettagliato). Dall'altro non riusciva comunque a prevedere ogni possibilità e quando si voleva creare un documento necessario, anche se non previsto dal sistema, non era chiaro come si potesse estendere in modo ordinato il sistema degli indici.

Scelta di Base

Rispetto alle metodologie utilizzate in passato, in questo "tentativo" il numero di dcl è stato fortemente ridotto. Ad oggi siamo a circa 19 dcl contro più di 150 tipi documento presenti in mssi e un numero ancora superiore in Method-1. A nostro avviso in questo modo si realizza un sistema più flessibile in quanto i tipi di contenuto all'interno di queste grandi categorie possono essere variati più liberamente. All'interno di una dcl tutti i documenti sono identificati tramite un nome. Tale nome deve essere univoco all'interno della dcl. Qualunque documento può essere referenziato tramite una stringa nel formato #dcl(nome)¹.

Nel caso anche si volesse produrre un manuale con "esempi" di tipi documento, esempi che in MSSI e Method-1 sono un'utile fonte di ispirazione, è possibile produrli anche nell'ambito di sole 21 categorie. In questo caso per referenziare un esempio sarà necessario indicare sia la dcl che il nome del documento di esempio.

Definizione

Una classe di documenti raccoglie una "famiglia" di documenti con un certo tipo di contenuti. Alcune di queste famiglie sono molto generiche e possono essere ulteriormente suddivise progetto per progetto, ad esempio le famiglie req, dsg, dst, amm, ris.

Altre famiglie sono molto più specifiche come ad esempio src, dat, daf, ecc. Tipicamente queste riguardano elementi "concreti" dello sviluppo del software.

I nomi possono essere qualificati e in alcuni casi la parte iniziale della qualifica indica una sotto-classe di documenti. Ad esempio all'interno della classe req i nomi che iniziano con "law" indicano che il documento riporta il testo di una legge. I suggerimenti sui prefissi da utilizzare sono da considerarsi come tali. Da adottare quando si adattano alla situazione, da ignorare o da integrare negli altri casi.

In ogni caso il nome deve essere univoco, e comunque sia costruito il nome deve essere costruito in modo tale da non indurre a cambiarlo in momenti successivi con il progredire dell'analisi. Ad esempio è un'errore nominare i documenti di analisi sulla base di un'outline di un "manuale di disegno funzionale". La struttura del manuale cambia con il tempo e tale sistema di nomenclatura comporta un continuo rinominare i documenti già prodotti e conseguente rincorsa ai dangling link.

Categorie

Nell'ambito di ciascuna dcl o classe di documenti è possibile definire una struttura gerarchica di categorie entro le quali classificare i documenti.

Lo scopo delle categorie è di permettere un continuo procedimento di strutturazione e ristrutturazione dei documenti senza dover agire sul nome dei medesimi. Le categorie prevedono un meccanismo di ordinamento dei documenti a parità di categoria.

Notes permette di assegnare ad ogni singolo documento più di una categoria. Tale feature può sulla carta risultare comoda, ma in pratica a mio avviso crea una confusione tra il concetto di categoria e il concetto di ricerca per parole chiave. La categoria è uno strumento di classificazione e il singolo documento deve rientrare in una sola classe.

In certi casi si può volere che due dcl usufruiscano della medesima struttura di categorie. Questa cosa si può fare duplicando la struttura da una dcl all'altra.

---

¹ L'uso di queste sigle è universalmente accettato sia da notes che nei commenti dei sorgenti. In notes è possibile utilizzare direttamente un link notes.