Estoy creando esto en ms word, para crear una carpeta de 3 anillas con pestañas, llena de documentación de todo lo relacionado con nuestro servidor web.
¿Cuáles son las principales categorías que debo incluir?
Tenemos 2 servidores, ambos windows, 1 para web, 1 para servidor sql, 1 web, ejecuta iis7 y coldfusion.
No tengo formación como administrador de sistemas, sólo cosas que he aprendido. Por ejemplo, prefiero tener más información que ninguna información, como cuando acabamos de migrar nuestros servidores y nos perdimos un montón de cosas porque no había documentación.
¿Entonces quiero hacer un trabajo minucioso? No me importaría esto como wiki, pero mi jefe y mis compañeros de trabajo no están muy familiarizados con los wikis ni con cómo usarlos. Tiendo a ser el anal de nuestro grupo, quiero poner los puntos en todas las íes y documentar todo.
¿Alguna sugerencia?
Respuesta1
Hasta cierto punto, lo que incluyas dependerá en gran medida deOMSestás documentando. ¿Está documentando para los administradores? ¿Para los usuarios? ¿Para programadores? ¿Todo lo anterior? Al igual que cuando diseñas un sitio, debes observar los casos de uso y resolverlos.
Cosas que consideraría críticas para la documentación que me proporcionaron como programador y/o administrador de sistemas:
- cómo se crean las copias de seguridad
- cómo se deben restaurar las copias de seguridad
- cómo configurar el sitio desde cero (software requerido, proceso de instalación, configuración, etc.)
- lista de dependencias (necesita CF, SQL Server, necesario para x)
- documentación de cualquier API en uso
- Documentos de requisitos originales, documentos de cambio (si existen).
- información sobre cómo crear/usar la administración
- proceso para cambiar el acceso cuando un usuario se va (revocar el acceso del usuario, cambiar las contraseñas compartidas, etc.)
- cualquier personalización específica de usuario/cliente/proceso
- cualquier escenario "te pillé"
- cualquier documentación existente para los usuarios
- tareas programadas y sus horarios
- Procesos que deben ejecutarse periódicamente (actualizaciones de índice, desfragmentación, etc.) como parte del mantenimiento.
Si está creando una fuente electrónica, como un wiki, sería bueno tener estos:
- composiciones y maquetas originales
- fuentes de imagen
- archivos flash .fla
- enlaces desde el sitio existente a requisitos/documentos de cambio
- una copia actual del código de lanzamiento, con la fecha/versión/etc. actualizado con cada lanzamiento importante o en un cronograma (como mensualmente).
Respuesta2
Utilice OneNote para su documentación en lugar de Word
- Múltiples usuarios pueden usarlo simultáneamente.
- Exportar a pdf si lo desea
- La funcionalidad de hacer clic con el botón derecho en "enviar a onenote" ha aumentado el valor de nuestra documentación.
- ediciones de seguimiento
Estas son sólo algunas de las características. Para nosotros, en realidad hay demasiados beneficios como para enumerarlos.