Dove posso trovare un modello per la documentazione sull'installazione del software lato server? [chiuso]

Question

Sto cercando un buon modello per l'installazione di software sul lato server per un progetto a cui sto lavorando.

Il lato client è piuttosto semplice. L'installazione sul lato server è un po 'più complicata. È composto da diversi pezzi (servizi, connessioni al database, dipendenze, porte che devono essere sbloccate, ecc.). Durante un recente test, sono stati scoperti diversi pezzi non documentati. Ora devo creare la documentazione di installazione per i nostri piani di ripristino di emergenza e i modi per testare l'installazione senza necessariamente avere un "full-up" sistema su cui testare.

Vorrei davvero un suggerimento su dove posso ottenere un modello o un ottimo esempio di tale documento. Mi piacerebbe che fosse qualcosa che un operatore potesse leggere e comprendere nel calore di una ripresa.

---

[EDIT] La nostra documentazione attuale proviene principalmente dalle domande poste dai nostri amministratori durante i test fuori sede. Man mano che il nuovo codice viene scritto, vorrei assicurarmi che la documentazione sia scritta in anticipo. Sto raccogliendo immagini VMWare per iniziare i test, ma stavo cercando alcuni buoni esempi. È un negozio di Windows Server (2000 e 2003). I template di Word sarebbero fantastici, ma se vedessi una buona documentazione, potrei crearli. Anche qualsiasi suggerimento su ciò che dovrebbe essere testato sarebbe fantastico.

---

[2a EDIT] Ho ricevuto diverse buone idee dalle risposte postate. Dopo aver modificato la mia ricerca su Google, ho trovato alcuni buoni punti di partenza. Non sono perfetti, ma sono un buon inizio.

Microsoft Exchange - http://technet.microsoft .com / it-it / library / bb125074 (EXCHG.65) .aspx iPhone - http://manuals.info.apple.com/en_US/Enterprise_Deployment_Guide.pdf

http://www.novell.com/documentation/gwgateways/gw7_exch/index.html?page=/documentation/gwgateways/gw7_exch/data/ab32nt1.html http: //cregan.wordpress .com / 2006/06/22 / scambio-2003-step-by-step-installation-istruzioni /

http://technet.microsoft.com/en-us/magazine /cc160942.aspx

Copre bene la pianificazione in fase di progettazione - http://www.onlamp.com/pub/a/onlamp/2004/04/08/disaster_recovery.html?page=2

---

[Modifica 29/10/2008]
QUESTO è il tipo di campione che stavo cercando. Non ha molta spazzatura, ma sembra spiegare abbastanza il perché insieme a come http: //wiki.alfresco.com/wiki/Installing_Labs_3_Nile

Answer 1

Cosa dovrebbe essere testato? Bene, nel caso di un sito web, " puoi accedere alla pagina? " Includi un URL come punto di partenza e lascia che l'amministratore faccia clic fino a un certo punto. Non è necessario che l'amministratore esegua l'intero ciclo di QA, solo una conferma che ciò che intendevi distribuire è realmente ciò che è stato distribuito.

---

Altre idee Inoltre, noi (il mio team nel mio ultimo lavoro) abbiamo fatto eseguire il test di controllo qualità dell'implementazione. Come dovrebbe essere una persona responsabile del QA, non era intimo con i dettagli e, quando è stato distribuito al QA, siamo stati in grado di ottenere un feedback su ciò che è andato storto.

Un'altra cosa utile è sedersi con gli amministratori prima della distribuzione. Esamina le istruzioni e assicurati che le comprendano nello stesso modo in cui lo fai.

---

Modello? Basta creare sezioni con campi per dati come URL su DEV, QA e PROD. Quando scrivi le istruzioni puoi fare riferimento a quelle. Basta chiarire cosa viene distribuito.

Answer 2

Il metodo più completo che abbiamo ideato per creare la nostra documentazione DR, prevede l'esecuzione di un ciclo completo (o due) di installazione e la documentazione di ogni passaggio lungo il percorso.

Mi rendo conto che questo può essere un po 'difficile se non hai un sistema di test (o di sostituzione) da usare per creare la tua documentazione - ma vale la pena fare pressioni per eseguire questo ciclo almeno una volta.

(lo consiglio due volte, il secondo è fatto da qualcuno che non è coinvolto nel progetto: ecco come testare la documentazione per i futuri amministratori, che potrebbero non avere la stessa esperienza del processo.)

Un effetto collaterale di quanto sopra è che la tua documentazione cresce abbastanza grande - l'ultima volta che ho dovuto farlo, credo che il manuale di installazione completo per i nostri server di database fosse di oltre 30 pagine.

Answer 3

A seconda degli amministratori, l'automazione è utile. Ho avuto amministratori di Windows che desiderano un documento Word con istruzioni dettagliate e altri amministratori che desideravano uno script.

Tuttavia, alcune cose utili da includere, probabilmente come sezioni

• Modifiche al database
  • Script da eseguire
  • Verifica del loro funzionamento
• Modifiche alla configurazione
  • quali sono le modifiche
  • dov'è una versione del nuovo file (Nel mio caso hanno diffuso i due, il che ha contribuito a ridurre gli errori relativi ai valori specifici della produzione)
• Verifica generale
  • cosa dovrebbe essere diverso dal punto di vista dell'utente (modifiche alle funzionalità)
• Per le distribuzioni di Web farm, potrebbe essere utile disporre di un documento di coordinamento su come i server devono essere estratti e estratti dal pool.