¿Dónde puedo encontrar una plantilla para la documentación sobre la instalación de software en el lado del servidor?[cerrado]

Question

Estoy buscando una buena plantilla para la instalación de software del lado del servidor para un proyecto en el que estoy trabajando.

El lado del cliente es bastante sencillo.La instalación del lado del servidor es un poco más complicada.Se compone de varias piezas (servicios, conexiones de bases de datos, dependencias, puertos que deben desbloquearse, etc.).Durante una prueba reciente se descubrieron varias piezas indocumentadas.Ahora necesito crear documentación de instalación para nuestros planes de recuperación ante desastres y formas de probar la instalación sin tener necesariamente un sistema "completo" para realizar la prueba.

Realmente me gustaría recibir una sugerencia sobre dónde puedo conseguir una plantilla o un ejemplo realmente bueno de dicho documento.Me gustaría que fuera algo que un operador pudiera leer y comprender en plena recuperación.

---

Editar] Nuestra documentación actual proviene principalmente de las preguntas que nuestros administradores han tenido durante las pruebas fuera del sitio.A medida que se escribe código nuevo, me gustaría asegurarme de que la documentación esté escrita con anticipación.He estado recopilando imágenes de VMWare para comenzar a realizar pruebas, pero estaba buscando algunos buenos ejemplos.Es una tienda de Windows Server (2000 y 2003).Las plantillas de Word serían geniales, pero si pudiera ver buena documentación, podría crear las plantillas.Cualquier sugerencia sobre lo que debería probarse también sería excelente.

---

2da edición] He obtenido varias buenas ideas de las respuestas publicadas.Después de cambiar mi búsqueda en Google, se me ocurrieron algunos buenos puntos de partida.No son perfectos, pero son un buen comienzo.

intercambio de microsoft - http://technet.microsoft.com/en-us/library/bb125074(EXCHG.65).aspxiPhone - 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/exchange-2003-step-by-step-installation-instructions/

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

Cubre bien la planificación en la etapa de diseño. http://www.onlamp.com/pub/a/onlamp/2004/04/08/disaster_recovery.html?page=2

---

[Editar 29/10/2008]
ESTE es el tipo de muestra que estaba buscando.No tiene mucha basura, pero parece explicar suficiente el por qué junto con el cómo. http://wiki.alfresco.com/wiki/Installing_Labs_3_Nile

Answer 1

¿Qué se debe probar? Bueno, en el caso de un sitio web, "¿Puedes llegar a la página?" Incluya una URL como punto de partida y deje que el administrador haga clic hasta cierto punto.No es necesario que el administrador pase por todo el ciclo de control de calidad, solo una confirmación de que lo que pretendía implementar es realmente lo que se implementó.

---

Otras ideasAdemás, nosotros (mi equipo en mi último trabajo) hicimos que el control de calidad probara la implementación.Como debería ser una persona de control de calidad, no conocía los detalles y, a medida que se desplegaba en control de calidad, pudimos obtener comentarios sobre lo que salió mal.

Otra cosa que es útil es sentarse con los administradores antes de la implementación.Repase las instrucciones y asegúrese de que las entiendan de la misma manera que usted.

---

¿Plantilla? Simplemente cree secciones que tengan campos para datos como URL a DEV, QA y PROD.Cuando escriba las instrucciones, podrá consultarlas.Simplemente deje en claro lo que se está implementando.

Answer 2

El método más completo que hemos ideado para crear nuestra documentación de DR implica realizar un ciclo completo (o dos) de instalación y documentar cada paso a lo largo del camino.

Me doy cuenta de que esto puede ser un poco difícil si no tienes un sistema de prueba (o reemplazo) para usar para crear tu documentación, pero vale la pena presionar para ejecutar este ciclo al menos una vez.

(Recomiendo dos veces, la segunda la realiza alguien que no esté involucrado en el proyecto; así es como se prueba la documentación para futuros administradores, que pueden no tener tanta experiencia con el proceso).

Un efecto secundario de lo anterior es que su documentación crece bastante; la última vez que tuve que hacerlo, creo que el manual de instalación completo para nuestros servidores de bases de datos tenía más de 30 páginas.

Answer 3

Dependiendo de los administradores, la automatización es útil.He tenido administradores de Windows que querían un documento de Word con instrucciones paso a paso y otros administradores que querían un script.

Sin embargo, algunas cosas útiles para incluir, probablemente como secciones.

• Cambios en la base de datos
  • Guiones para ejecutar
  • Verificación de que trabajaron.
• Cambios de configuración
  • cuales son los cambios
  • ¿Dónde está una versión del nuevo archivo (en mi caso, diferenciaron los dos, lo que ayudó a reducir los errores relacionados con los valores específicos de producción)?
• Verificación general
  • qué debería ser diferente desde la perspectiva del usuario (cambios de funciones)
• Para las implementaciones de granjas web, podría resultar útil tener un documento de coordinación sobre cómo se deben incorporar y sacar los servidores del grupo.