He sido socio en un servicio de contratación / consultoría de tres personas desde junio de 2004. Cada uno de nosotros trabajamos principalmente nuestras propias "cuentas", sin embargo, necesitamos mantener la documentación el uno para el otro para permitir la "conmutación por error" entre los socios. La mayoría de nuestros clientes tienen algún tipo de personal interno de TI, muchos de los cuales realizan una cierta cantidad de mantenimiento diario, y también necesitamos comunicarles la documentación de manera efectiva.
Mis dos socios tienen la ventaja (si se puede llamar así) de haber trabajado como empleados para mí en otra empresa y, como resultado, ambos fueron adoctrinados a mi forma de hacer las cosas. La consistencia estricta (donde las cosas, obviamente, pueden estar) entre las configuraciones de los Clientes es una bendición. Obviamente, los productos cambian, por lo que nos reunimos para discutir nuevos productos / versiones, etc., y decidir una estrategia de configuración consistente antes de implementar. Esto no se adaptaría a una gran empresa, pero, francamente, lo veo como una característica en lugar de un error. (No comenzaré a despotricar sobre compañías más grandes de "servicios administrados" con sus "ingenieros" empleados y las tendencias horribles para "soluciones" únicas y mediocres, e inconsistencia entre los Clientes ...> sonrisa <)
Estoy violentamente en contra de "la temida carpeta". Nunca he visto documentación física actualizada nunca . Creo que es una pérdida de dinero del Cliente gastar tiempo haciendo copias físicas de la documentación. Prefiero pasar el tiempo resolviendo cómo generar documentación basada en datos "en vivo" a partir de configuraciones en ejecución.
Como ejemplo, absolutamente no mantendré hojas de cálculo de información de dirección IP. Para eso sirven DHCP y DNS (ver detalles más abajo). Si esas cosas no funcionan, entonces tenemos problemas importantes.
Hemos hecho que los Clientes soliciten cosas como "hacer un documento que muestre toda la configuración de nuestra Política de grupo" y me puse a prueba y me negué a hacerlo. Mi contrapropuesta recurrente (que hasta ahora ha funcionado) ha sido presentarle al Cliente herramientas administrativas que pueden brindarle "autoservicio" o usar software para generar documentación "en vivo" amigable para el cliente a pedido.
Nos esforzamos mucho por ser meticulosos al deletrear las cosas en inglés simple. Un contacto de TI no técnico puede, por ejemplo, revisar la membresía de grupo de Active Directory de una computadora y ver cosas como "Software - Instalar Microsoft Office 2010 Pro" y "Política de grupo - Inicio de sesión automático de computadora de kiosco de envío". No se necesita ninguna documentación para explicar qué significan esas cosas.
Aquí hay algunos datos "en vivo" que utilizamos:
Toda la asignación de direcciones IP se almacena en servidores DHCP; esto también incluye dispositivos con direcciones estáticas (como se indica en los comentarios). Las direcciones MAC e IP pueden consultarse fácilmente mediante scripts o manualmente y, por definición, los datos deben estar actualizados si se utilizan en producción.
Todo recibe un nombre y un registro PTR en DNS. La mayoría de los anfitriones también obtienen un registro HINFO. Las cosas que necesitan descripciones detalladas obtienen un registro TXT.
Uso copioso y detallado de los campos de "Notas" en cualquier lugar posible: Active Directory, descripciones de computadora, descripciones de carpetas compartidas, etc. También somos detallados y claros con cosas como nombres de grupos de seguridad.
Comentarios / observaciones en configuraciones de redes (comentarios sobre ACL, descripciones de puertos, ubicación SNMP / información de contacto, por ejemplo).
Soy bastante negativo sobre la idea del almacenamiento de información de forma libre en cosas como archivos de texto, wikis, etc. La estructura es una buena búsqueda. Siempre que pueda obtener un mecanismo de almacenamiento estructurado que funcione para mí (incluso si eso significa que tengo que escribir un software para consultarlo) lo prefiero. Los comentarios que puedo analizar de los archivos de configuración, bases de datos, etc., siempre me convencen cuando los comparo con documentos generados manualmente que quedarán desactualizados casi de inmediato.
Cuando tenemos que almacenar información de "forma libre", usamos nuestro propio repositorio SVN. Contiene todos los diversos fragmentos de documentación estática que hemos creado a lo largo de los años, archivados por el Cliente. Hemos estado usando SVN para esto desde 2004 y ha funcionado muy bien como una herramienta de colaboración para nosotros. Realizamos versiones de esquemas de bases de datos, sysadmin scripts, copias de seguridad de objetos de directiva de grupo, etc. Intento verificar todo lo que puedo en el control de versiones.
Es muy fácil buscar en mi caja con herramientas de indexación basadas en el sistema de archivos. Sé que cada uno de nosotros tiene al menos una copia completa del repositorio disponible localmente en cualquier momento. También hicimos accesible el repositorio a través de WebDAV autenticado a través de SSL en caso de que tengamos que acceder a los datos almacenados allí y solo tengamos acceso al navegador.
Nunca se nos ha pedido que lo hagamos, pero estaríamos encantados de crear una cuenta en el servidor SVN para permitir que un Cliente saque e interactúe con sus propios archivos (si tienen un recurso interno que está dispuesto ) Utilizamos un formato estandarizado para almacenar toda la documentación estática del Cliente (documentación de la licencia de software, registros de compra, etc.) que se explica por sí misma.
Junto con el repositorio SVN, también autohospedamos nuestro correo electrónico. Todos los correos electrónicos entrantes / salientes se han archivado desde que el dominio de la compañía comenzó a recibir correos electrónicos. Está disponible como registros BSMTP a los socios para referencia (y, personalmente, he encontrado que es invaluable). La situación nunca ha surgido, pero sé que nos complacería brindarle a un Cliente acceso a los registros de cualquier correspondencia a / de sus empleados si alguna vez lo solicitan. Facilitar la comunicación interna entre los socios sería más difícil porque podríamos hacer referencia a varios Clientes en el mismo mensaje. (Probablemente deberíamos ser mejores al respecto, pero no lo hemos sido).
Las contraseñas son una "verruga" importante en nuestro proceso. Estamos utilizando repositorios individuales de "Contraseña segura" (con combinaciones únicas) para cada Cliente para permitir que el archivo seguro sea compartido con el Cliente. Mantenemos las contraseñas maestras para todos los archivos seguros en otro archivo seguro, con una combinación conocida solo por los socios. Esta parte realmente necesita algo de trabajo. Creo que nos gustaría que cada Cliente aloje una bóveda de credenciales en el sitio utilizando una aplicación de bóveda de contraseñas multiusuario real (con una pista de auditoría, etc.) pero hemos estado sacando esa idea por la playa durante casi 10 años. .
Nuestros registros de seguimiento del tiempo son meticulosamente detallados y se proporcionan a los Clientes en cualquier formato electrónico que deseen (que, hasta este momento, han sido texto y PDF ASCII). Los clientes obtienen tiempos de inicio / parada en cada evento facturable y una descripción detallada del trabajo realizado. Consideramos que estas notas de servicio son muy valiosas internamente porque nos permiten mantenernos al día con lo que sucede en los sitios de Clientes de los socios. En el caso de un problema, estos registros nos brindan un conocimiento basado en todos los problemas y resoluciones anteriores que hemos encontrado a lo largo de los años. No me da vergüenza decir que he resuelto problemas para un Cliente al encontrar notas que olvidé escribir para otro Cliente años antes.
Una advertencia rápida y cautelosa sobre la producción de documentación: en mi "antiguo trabajo" (trabajar para alguien más hace años), la compañía inició una acción legal contra un Cliente que no paga. Terminamos en el negocio de una contra demanda del Cliente que no paga. Nuestros registros internos y correo electrónico re: que el Cliente fue citado y expuesto ante el tribunal. Esa experiencia me enseñó mucho acerca de no almacenar nada en un medio fijo que no desea que se haga público.
Había escrito algunos mensajes de correo electrónico con algunos (ERM) Choice palabras y frases en ellos sobre mis frustraciones con este cliente y con algunos de los otros "ingenieros" en mi empresa. Tener que ser interrogado sobre estas cosas en audiencia pública no era algo que disfrutara en absoluto.
Cuando comenzamos nuestro negocio actual, los socios acordaron que todos los registros fijos (correo electrónico, mensajes de texto, correo de voz, archivos en el repositorio SVN, registros de trabajo en el rastreador de tiempo, etc.) se considerarían "orientados al cliente" todo el tiempo, incluso si nunca tuvieron la intención de terminar en manos de los Clientes. Esto ha sido difícil de hacer y requiere mucha disciplina, pero creo que vale la pena. Ciertamente queremos proyectar un aire de profesionalismo a nuestros clientes, y vivirlo es la forma de hacerlo. Ciertamente nunca me avergonzaré como si estuviera en esa sala de la corte otra vez.