Quali standard utilizza la tua squadra per le intestazioni e i footer dei documenti delle specifiche?

Il modo migliore per gestire il controllo dei documenti è avere una politica di gestione della configurazione chiara e ben documentata. Questa politica dovrebbe affrontare il controllo delle versioni di tutto ciò che riguarda il progetto, dalle librerie esterne al codice alla documentazione. Nella stessa posizione, puoi anche gestire la gestione delle modifiche: come gestire le modifiche a qualsiasi aspetto del progetto, dai requisiti al codice.

La chiave è avere un qualche tipo di sistema per tenere traccia delle modifiche e delle revisioni. Al lavoro, usiamo SharePoint. Probabilmente potresti cavartela usando qualsiasi sistema di controllo della versione, ma sei

Probabilmente mantieni il codice in un sistema di controllo della versione. L'idea è che si faccia lo stesso con i documenti, anche se probabilmente si desidera abilitare il blocco per i documenti poiché la fusione di file binari (documenti di Word e così via) potrebbe non essere possibile.

Il documento ufficiale della versione deve essere conservato sulla intranet aziendale o in qualche luogo con controllo della sicurezza e degli accessi appropriato. Al lavoro, usiamo SharePoint, che gestisce anche il controllo delle versioni. Se usi qualche altra tecnologia o strumenti, potresti essere in grado di sfruttarli (magari con plugin o estensioni). Assicurati solo che tutti sappiano dove andare per trovare la documentazione ufficiale più recente e migliore.

È inoltre necessario tenere traccia non solo dell'identificatore della versione corrente, ma anche della cronologia delle revisioni, all'interno del documento. In questo modo, quando stampi il documento, diventa facile "differirli" e capire quali sezioni sono state modificate tra due copie fisiche.

Solo per descrivere cosa, in particolare, i nostri documenti assomigliano a:

La prima pagina è una copertina. Il logo aziendale o del progetto si trova nell'angolo in alto a sinistra. L'ID del documento, la data di modifica tardiva e l'ID di revisione si trovano nell'angolo in alto a sinistra. I segni di classificazione sono centrati nell'intestazione e nel piè di pagina. Il titolo del documento è approssimativamente centrato sulla pagina. Sotto il titolo vengono fornite tutte le informazioni sul copyright e sulla distribuzione applicabili.

Su tutte le altre pagine, l'intestazione contiene i contrassegni di classificazione al centro e il nome del documento nell'angolo a destra. Il piè di pagina contiene l'ID del documento e l'ID di revisione nell'angolo sinistro, i contrassegni di classificazione al centro e il numero di pagina a destra.

La pagina successiva è la pagina di approvazione. Contiene il titolo del documento e il numero ID, insieme alle firme e alle date del preparatore e dell'approvatore. Sulle copie con versione ufficiale, il documento ha effettivamente un'immagine con le firme al suo interno.

La terza pagina è il record di revisione, che di nuovo come titolo e ID del documento, seguito da una tabella che fornisce un ID di revisione (di solito una lettera), qualsiasi richiesta di modifica associata alla revisione per rintracciare i rapporti sui difetti (sì - archiviamo i difetti rispetto ai documenti), la data delle revisioni e le pagine / sezioni modificate.

What header/footer do you put on your Functional&Technical specifications to avoid people having different versions at meetings?

Non abbiamo un set standard in progetti Accoss di pietra, ma qualcosa del genere sarà un buon minimo:

• progetto
• sottosezione del progetto
• creatore
• crea data / ora
• ultima modifica
• ultima data / ora modificata

Ancora meglio è controllare le specifiche e progettare i documenti nel controllo del codice sorgente (Sharepoint fa molte cose uguali se è più facile per gli uomini d'affari). Il controllo di Souce registrerà tutte le cose sopra, oltre a conservare una cronologia di tutte le modifiche. Inoltre, consiglierei di forzare i commenti con i check-in. I commenti significativi sui changeset possono essere di grande aiuto se le verifiche si verificano frequentemente da molte persone. Fondamentalmente, considera le specifiche come una parte del progetto (perché lo è).

Non mostrare troppe informazioni nella parte superiore e inferiore di ogni pagina. Non porta altro che distrazione.

In generale, metti su ogni pagina il numero della pagina, il titolo del documento (incluso, facoltativamente , il nome del progetto), e questo è tutto. Se il documento è lungo (leggi più di trenta pagine), puoi includere anche il capitolo / parte, ma questo ha un problema quando il documento è gestito dalle persone senza molto background tecnico: di solito non sanno come fare correttamente nei programmi di modifica del testo che usano.

Non utilizzare nemmeno il numero di versione. Alcune persone non hanno problemi con questo. Altri, come me, non sono completamente in grado di ricordare di aggiornare il numero di versione in un'intestazione quando aggiornano il documento.

Quello che puoi fare per rendere più semplice la gestione di versioni diverse (e ciò che viene fatto da molte aziende da quello che ho visto) è mettere sulla prima pagina l'elenco delle revisioni del documento , con data, nome dell'autore e un riepilogo delle modifiche.

Ci sono altre due cose che puoi fare, ma sono meno legate al documento e più alle persone e all'organizzazione della riunione:

1. Prima della riunione, chiedi a tutti se hanno scaricato l'ultima versione del documento. Pronunciare "ricorda che il documento è stato aggiornato ieri sera" può aiutare le persone a capire che potrebbero avere dimenticato di controlla per l'ultima versione.

2. Non stampare documenti. Se all'interno della tua azienda, tutti o quasi tutti hanno un notebook, perché dovrebbero avere una versione cartacea del documento? Perché dovrebbero ristamparlo ancora e ancora ad ogni revisione? Un documento di venti pagine con trenta revisioni stampate da quindici persone nel team può avere un costo elevato, sia per la tua azienda che per l'ambiente.
   Se non hai abbastanza laptop, investire in un grande schermo o un proiettore per la tua sala riunioni può essere una buona alternativa (anche se un documento per persona è molto più comodo).

Uso questa convenzione:

• I documenti vengono sempre controllati in un repository di subversion. Non hanno la versione nel loro nome, quindi c'è una cronologia delle revisioni in sovversione e in modo che abbiano un collegamento permanente URL che può essere condiviso con le persone.
• La prima pagina del documento contiene una tabella che descrive ciascuna versione con numero di versione, autore, riepilogo delle modifiche e data di modifica. Ogni volta che qualcuno modifica il documento, aggiunge una riga sulla copertina e memorizza il file.
• Il blocco di Subversion viene utilizzato per impedire modifiche simultanee.
• I documenti tendono a sopravvivere ai sistemi di archiviazione dei documenti in cui sono conservati, quindi il documento deve contenere la propria cronologia completa.