amm.rel: Release software, situazione proposta


Andrà nella categoria pio.dcl

Richieste degli utenti

  1. Si devono abolire i link dai documenti release
  2. Tenere separate le parti relative alle correzioni effettuate da quelle delle nuove funzionalità, mettendole in coda al testo
  3. Non far risultare le testate, salvo l'ultima.
  4. E' importante che la formattazione dei documenti dei diversi sistemi sia omogenea, come font, come livelli di titoli, come utilizzo di riferimenti.

Nuova procedura documentazione rilasci

Si è pensato di realizzare un nuovo sistema per

  • 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.

Nuovo documento "release"

Si introdurrà un nuovo documento (DCV / form Notes) : "REL", che potrà essere utilizzato anche per i documenti di tipo "milestone".

Questa nuova form avrà tre campi rich text:

  • Header, nel quale si inserirà la tabella fissa di cui sopra
  • Body, che conterrà il testo relativo ad avvertimenti / nuove funzionalità
  • Corrections, che conterrà il testo relativo alle correzioni.

Questo documento risulterà visibile in un'apposita vista "amm\release". Non sarà stampabile tramite funzioni DAR nel database di origine.

I documenti avranno struttura, nome ecc... identici agli attuali documenti "release".

Procedura di copia documenti release

Si prevede una semplice procedura di copia semi- automatica descritta qui di seguito.

  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" verrà 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 sarà costruito con il titolo della release di partenza seguito da "- correzioni"
      1. come categoria: nome del nome del manuale \ sistema
      2. nel campo "body" verrà riportato il contenuto del solo campo "Corrections" di cui al punto precedente

Per ogni documento prodotto, la procedura genererà una riga in un documento "MAN" con nome uguale a <nome manuale> nella quale venrranno 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 pubblicaione release dovrebbe effettuare la copia dei tre campi "rich text": Header, Body, Corrections.

In questo modo tutti i documenti DAR delle release "pubblicate" sul DB release sarebbero 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 potrebbe comprendere 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.

dsu.pio.dcl.amm.rel_2 • LastModified: 14-9-2007 • Cesare Bacchini