Documentazione fornisce audit trail di lavoro che è stato completato

# 13: documentare tutto

L'importanza di una buona, solida documentazione semplicemente non può essere sopravvalutata. Documentazione fornisce audit trail di lavoro che è stato completato. Esso prevede le guide per gli amministratori di sistema di futuro, in modo che possano prendere in consegna i sistemi che esisteva prima del loro arrivo. E 'in grado di fornire l'amministratore del sistema e la sua gestione con i record realizzazione. (Questi possono essere molto utile al momento il personale di revisione.) Buona documentazione può anche aiutare con la soluzione dei problemi.

1. La prima udienza è l'autore stesso. Documentazione volta a l'autore del software lo rende molto più facile per l'autore di tornare indietro e il debug di problemi nel proprio codice che possono verificarsi anni più tardi. Quando si guarda indietro a proprio due o tre-anno-vecchio lavoro (sistema o di una progettazione di rete o programmi, per esempio), può essere quasi impossibile da ricordare perché l'avete fatto qualcosa di un modo particolare, e non un altro modo, pur avendo ottimi motivi al momento. Scrivere commenti nel codice. Scrivere manuali, anche se sono solo un paio di pagine.

2. Il secondo è quello in futuro. Le persone che mantengono i sistemi e le applicazioni di oggi non sarà in giro per sempre. E non si può supporre che ogni personale esperto sarà intorno ai nuovi arrivati mentore. Si deve preparare per un esodo massiccio di vostra gente con esperienza. Un segnale importante sulle scrivanie molti amministratori di sistema ', si legge: "Ricordati, 100 anni da oggi, tutte le nuove persone!"

3. Il pubblico terzo è la gestione. Mantenere buone note e documentare il lavoro aiuta a dimostrare di gestione che è stato diligente e indica quali misure sono state adottate per mantenere i sistemi di gestione e produttivi. Se un sistema non soddisfa i requisiti stabiliti nella documentazione, dovrebbe essere facile capire perché e per stabilire che cosa deve essere fatto per rendere il sistema compatibile. Anche se la vostra gestione non comprendere il valore dei servizi forniti per l'organizzazione, che di solito comprendere il valore quando si presenta come una spessa pila di documentazione.

Assicurarsi che la documentazione sia memorizzato su carta troppo. Se il sistema è spento quando è necessario i manuali, non si sta andando ad essere in grado di arrivare a loro. Mantenerli in leganti in modo che possano essere facilmente modificato e aggiornato. Dopo la documentazione è scritta, non dimenticare di revisione e aggiornamento su base regolare. Documentazione Bad è peggio di niente. In caso di crisi, soprattutto se la maggior parte delle persone non sono informati circa, la documentazione può essere seguita alla lettera. Se è sbagliato, le cose possono andare di male in peggio. Una domanda comune circa la preparazione della documentazione è a quale livello tecnico dovrebbe essere scritto. Una scuola di pensiero sostiene che la documentazione deve essere scritto in modo che chiunque l'organizzazione, da un portiere per l'amministratore delegato, può seguire e, se necessario, portare il sistema dopo un disastro. Dopo tutto, il sistema di personale amministrativo non possono essere disponibili al momento, e qualcuno deve pur farlo. Mentre questo è un obiettivo nobile, è uno pratico. Lo stato dei sistemi critici cambiamenti per tutto il tempo. Il dettaglio più che è incluso in tale documentazione, il più veloce diventa out-of-date. Al fine di scrivere la documentazione in modo che una persona intelligente non addestrato potrebbe portare i sistemi o fare altri lavori critici su di essi in tempo di crisi, avrebbe dovuto essere così dettagliate da risultare ingestibile. Se il compito a portata di mano è quello di modificare un file cambiare una variabile ad un altro, per un amministratore di sistema opportunamente formati, la documentazione solo bisogno di dire, "Change ABC a XYZ in / directory / file.txt." Per una persona intelligente non addestrato, la documentazione sarebbe bisogno di dire:

1. Passare alla directory / directory digitando "cd / directory".

2. Aprire l'editor di testo vi digitando "vi file.txt".

3. Spostare il cursore verso il basso per la linea 300, digitando "300G".

e così via (in qualsiasi ambiente operativo è opportuno). Ogni volta che il numero di riga nel file modificato, la documentazione dovrà essere cambiato. Molte condizioni di errore avrebbe bisogno di essere trattati per la persona inesperta come pure, per esempio, se il tipo di terminale o il conteggio delle righe è impostata male, l'editor vi possono avere difficoltà a trattare con esso. In tal caso, quale dovrebbe essere la persona inesperta fare? La risposta giusta, dunque, è quello di scrivere la documentazione in modo che un esperto amministratore di sistema può usarlo. Non aspettatevi che l'amministratore di avere una grande esperienza nel vostro negozio, solo l'esperienza generale. In un ambiente Windows, destinazione un Microsoft Certified Engineer (MSCE). Negli ambienti Unix, gli amministratori di sistema esperti di destinazione. Se succede qualcosa al sistema attuale, personale amministrativo, si può ragionevolmente presumere che saranno sostituiti da persone esperte. La documentazione è un po 'come un bel pezzo di letteratura. Tutti vogliono dire di aver letto Moby Dick, ma in realtà nessuno vuole sedersi e leggere Moby Dick.

# 12: Impiegare Service Level Agreements

# 11: Piano Ahead

un articolo presentato da Ben Smeider

Disclaimer:Il nostro sito non è responsabile per il contenuto di questo articolo. Webarticles è una risorsa gratuita di informazioni.
Importante: Questo articolo "Documentazione fornisce audit trail di lavoro che è stato completato" è stato tradotto da un software automatico. Ci dispiace per eventuali errori di ortografia che possono essersi verificati. Grazie per la vostra comprensione.