amm.rel: Produzione documentazione rilasci

Lo scopo è di produrre un documento esplicativo, destinato ai clienti, contenente le nuove funzionalità presenti in una release che si va ad installare presso il cliente stesso.

Il documento è un manuale DAR (quindi anche in formato PDF) contenente la stampa dei documenti di release dei vari prodotti, a partire dall'ultima release installata fino alla release che si va ad installare.

Il manuale DAR creato si trova nel database DAR cliente del cliente interessato. Il contenuto del manuale DAR viene deciso da chi lo crea.

La procedura si fa carico di copiare i documenti relativi nel database cliente e creare un documento manuale contenente le informazioni organizzate in modo uniforme e coerente.

• evitare il lavoro manuale di copia-incolla dei documenti
• ottenere maggiore uniformità dal punto di vista estetico
• consentire la consultazione dal sito in modo più efficace.

Esempio di utilizzo

Supponiamo di dover creare un documento per il cliente Inarcassa, che ha installati i pacchetti NetSim, GL, AT.

Si verifica la situazione delle release del cliente nel documento "release\stato cliente".

	release	AM	GL	RS	GP	AT	SB	SV	FE	ARL	RsCli
	installate	15-8	11-13	14-15		5-16		5-5		5-12	14-15
	da installare	16-4	11-35	16-11		6-30		5-23		5-17	16-11

Come prima cosa si deve decidere in quale ordine si vuole che i pacchetti appaiano nel manuale.

Se decide che l'ordine sarà: RS-AT-GL-AM-Rscli. Il pacchetto SV non è utilizzato quindi si tralascia.

Si apre il database DAR RS, vista 9\varie\REL.

Si evidenziano le release da 14-16 a 16-11

Si preme il tasto "nuovo documento release".

Si dà il nome del manuale. E' il nome che comparirà sul frontespizio del manuale DAR prodotto. E' preferibile non utilizzare nomi troppo lunghi.

Si sceglie il nome del cliente.

Si ripete questa procedura in ordine per i sistemi AT, GL, AM, Rscli

NB: Rscli è documentato nel database DAR Clienti Inarcassa.

Al termine delle operazioni si apre il database DAR Clienti Inarcassa, vista 9.Varie\Amm. Si troverà una categoria RelDocs contenente una sub-categoria con il nome del documento.

Funzionamento dettagliato della procedura di copia documenti

1. L'utente seleziona un certo numero di documenti REL e lancia la procedura specificando come parametro il nome del cliente destinatario.
2. La procedura copia i documenti nel database relativo al cliente destinatario, in modo e per ogni documento evidenziato produce   
1. un documento "DCV" simile agli attuali con nome e titolo uguale al nome di partenza (es "RS.R015-011") e
1. come categoria: nome del manuale\ sistema
2. nel campo "body" viene riportato il contenuto del solo campo "Body" di cui al punto precedente
2. un secondo documento "DCV" simile agli attuali con nome e titolo uguale al nome di partenza (es "RS.R015-011") e in coda il suffisso "_c", mentre il nome è costruito con il titolo della release di partenza seguito da "- correzioni"
1. come categoria: nome del nome del manuale \ sistema
2. nel campo "body" viene riportato il contenuto del solo campo "Corrections" di cui al punto precedente

Per ogni documento prodotto, la procedura genera una riga in un documento "MAN" con nome uguale a <nome manuale> nella quale sono linkati i documenti testè copiati me nel seguente ordine:

• prima i documenti relativi a nuove funzionalità
• successivamente quelli relativi a correzioni

L'ordine nel quale i sistemi saranno aggiunti al documento sarà invece lo stesso ordine nel quale vengono aggiunti i sistemi al manuale.

In caso il documento MAN esista già, la procedura sostituirà alla sezione relativa al sistema interessato il nuovo blocco di LINK. Altrimenti lo accoderà al documento.

Visibilità delle release sul sito AR

Nella nuova situazione la procedura di pubblicazione release effettua la copia dei tre campi "rich text": Header, Body, Corrections.

In questo modo tutti i documenti DAR delle release "pubblicate" sul DB release sono presenti in forma integrale.

Rimane il problema delle eventuali release presenti nel DAR ma non nel DB release: le porzioni di testo relative a questi documenti dovrebbero essere copiate manualmente all'interno del testo - ovvero tramite una procedura batch che integra nel testo le zone rich text partendo dalla release successiva all'ultima pubblicata.

Una versione più avanzata comprenderà una procedura che gira per ogni cliente e, utilizzando i dati (già disponibili) del codice ultima release e della prossima release disponibile, crea un documento identico a quello menzionato dalla procedura semi-automatica illustrata più sopra. Il documento dovrebbe essere stampato in DAR e allegato alla home page del cliente.