Sou sócio de um serviço de consultoria / contratação para três pessoas desde junho de 2004. Cada um de nós trabalha principalmente suas próprias "contas", no entanto, precisamos manter a documentação uns dos outros para permitir o "failover" entre os parceiros. A maioria dos nossos clientes possui algum tipo de equipe de TI interna, muitos dos quais realizam uma certa quantidade de manutenção diária, e também precisamos comunicar a documentação com eficácia.
Meus dois parceiros têm a vantagem (se é que você pode chamar assim) de ter trabalhado como funcionários sob mim em outra empresa e, como resultado, ambos foram doutrinados pela minha maneira opinativa de fazer as coisas. A estrita consistência (onde as coisas, obviamente, podem estar) entre as configurações dos Clientes é uma dádiva de Deus. Obviamente, os produtos mudam, então discutimos sobre novos produtos / versões, etc., e decidimos sobre uma estratégia de configuração consistente antes de implantarmos. Isso não chegaria a uma grande empresa, mas, francamente, vejo isso como um recurso e não como um bug. (Não vou começar a reclamar sobre empresas maiores de "serviços gerenciados" com seus "engenheiros" de funcionários e tendências horríveis para soluções pontuais, "soluções" meia-boca e inconsistência entre os clientes ...> sorrir <)
Sou violentamente contra "o temido fichário". Eu nunca vi documentação física mantido até à data nunca . Acho que é desperdício de dinheiro do Cliente gastar tempo fazendo cópias físicas da documentação. Eu preferiria dedicar algum tempo a descobrir como gerar documentação com base em dados "ativos" das configurações em execução.
Como exemplo, eu absolutamente não manterei planilhas de informações de endereço IP. É para isso que servem o DHCP e o DNS (veja detalhes abaixo). Se essas coisas não estão funcionando, temos grandes problemas.
Solicitamos que os clientes solicitem coisas como "criar um documento que mostre toda a nossa configuração de Diretiva de Grupo", e eu segui o meu caminho e me recusei a fazê-lo. Minha contraproposta recorrente (que até agora funcionou) foi apresentar ao Cliente ferramentas administrativas que podem fornecer "autoatendimento" ou usar software para gerar documentação on-line amigável ao cliente sob demanda.
Nós nos esforçamos muito para ser meticulosos em explicar as coisas em inglês simples. Um contato de TI não técnico pode, por exemplo, revisar a associação ao grupo do Active Directory de um computador e ver itens como "Software - Instalar o Microsoft Office 2010 Pro" e "Política de Grupo - Logon automático do computador no quiosque para remessa". Não é necessária nenhuma documentação para explicar o que essas coisas significam.
Aqui estão alguns dados "ao vivo" que usamos:
Toda a alocação de endereço IP é armazenada em servidores DHCP - isso também inclui dispositivos endereçados estaticamente (como mencionado nos comentários). Os endereços MAC e IP podem ser consultados facilmente por scripts ou manualmente e, por definição, os dados devem estar atualizados se estiverem sendo utilizados na produção.
Tudo recebe um nome e um registro PTR no DNS. A maioria dos hosts também recebe um registro HINFO. Coisas que precisam de descrições detalhadas recebem um registro TXT.
O uso abundante e detalhado dos campos "Anotações" em qualquer lugar possível - Active Directory, descrições de computadores, descrições de pastas compartilhadas, etc. Também somos detalhados e claros com coisas como nomes de grupos de segurança.
Comentários / observações em configurações de equipamentos de rede (comentários sobre ACLs, descrições de portas, localização SNMP / informações de contato, por exemplo).
Sou bastante negativo com a idéia de armazenamento de informações de forma livre em arquivos de texto, wikis etc. A estrutura contribui para uma boa pesquisa. Sempre que posso obter um mecanismo de armazenamento estruturado para trabalhar para mim (mesmo que isso signifique que eu precise escrever um software para consultá-lo), prefiro. Os comentários que eu posso analisar dos arquivos de configuração, bancos de dados etc. sempre me conquistam quando comparados com documentos gerados manualmente que ficam desatualizados quase imediatamente.
Quando temos que armazenar informações "de forma livre", usamos nosso próprio repositório SVN. Ele contém todos os vários bits de documentação estática que criamos ao longo dos anos, arquivados pelo Cliente. Estamos usando o SVN para isso desde 2004 e funcionou muito bem como uma ferramenta de colaboração para nós. Versão de esquemas de banco de dados, scripts sysadmin, backups de objetos de Diretiva de Grupo etc. Tento verificar tudo o que posso no controle de versão.
É muito fácil pesquisar meu checkout com ferramentas de indexação baseadas em sistema de arquivos. Eu sei que cada um de nós tem pelo menos uma cópia completa do repositório disponível localmente a qualquer momento. Também tornamos o repositório acessível via WebDAV autenticado por SSL, caso tenhamos absolutamente que acessar os dados armazenados lá e ter apenas acesso ao navegador.
Nunca fomos solicitados a fazê-lo, mas ficaríamos felizes em criar uma conta no servidor SVN para permitir que um Cliente faça check-out e interaja com seus próprios arquivos (se eles tiverem um recurso interno que seja tão inclinado ) Utilizamos um formato padronizado para armazenar toda a documentação estática do Cliente (documentação de licença de software, registros de compra, etc.) bastante auto-explicativa.
Juntamente com o repositório SVN, também hospedamos nosso email automaticamente. Todos os emails de entrada / saída foram arquivados desde que o domínio da empresa começou a receber emails. Ele está disponível como registros BSMTP para os parceiros para referência (e, pessoalmente, eu achei inestimável). A situação nunca veio à tona, mas sei que ficaríamos felizes em fornecer ao Cliente acesso aos registros de qualquer correspondência de / para seus funcionários, se alguma vez perguntarem. Fornecer comunicação interna entre os parceiros seria mais difícil, pois poderíamos fazer referência a vários clientes na mesma mensagem. (Provavelmente deveríamos ser melhores nisso, mas não fomos.)
As senhas são uma grande "verruga" em nosso processo. Estamos usando repositórios "Password Safe" individuais (com combinações exclusivas) para cada Cliente para permitir que o arquivo seguro seja compartilhado com o Cliente. Mantemos as senhas mestras de todos os arquivos seguros em outro arquivo seguro, com uma combinação conhecida apenas pelos parceiros. Esta parte realmente precisa de algum trabalho. Acho que gostaríamos que cada Cliente hospedasse um cofre de credenciais no local usando um aplicativo de cofre de senha multiusuário real (com uma trilha de auditoria, etc.), mas estamos lançando essa ideia na praia há quase 10 anos .
Nossos registros de rastreamento de tempo são meticulosamente detalhados e fornecidos aos Clientes em qualquer formato eletrônico que eles desejem (que, até o momento, eram texto e PDF ASCII). Os clientes recebem horários de início / parada em cada evento faturável e uma descrição detalhada do trabalho realizado. Consideramos essas notas de serviço muito valiosas internamente porque elas nos permitem acompanhar o que está acontecendo nos sites dos clientes dos parceiros. No caso de um problema, esses registros fornecem um conhecimento de todos os problemas e resoluções anteriores que encontramos ao longo dos anos. Não tenho vergonha de dizer que resolvi problemas para um Cliente encontrando notas que esqueci de escrever para outro Cliente anos antes.
Um aparte rápido e cauteloso sobre a re-produção de documentação: No meu "antigo emprego" (trabalhando para outra pessoa anos atrás), a empresa entrou em uma ação legal contra um cliente que não pagava. Acabamos sendo alvo de uma ação judicial do Cliente não pagador. Nossos registros internos e e-mail referem que o Cliente foi intimado e exposto perante o tribunal. Essa experiência me ensinou muito sobre não armazenar nada em um meio fixo que você não deseja tornar público.
Eu escrevi alguns e-mails com algumas palavras e frases de escolha (erm) sobre minhas frustrações com este Cliente e com alguns dos outros "engenheiros" da minha empresa. Ter que ser interrogado sobre essas coisas em tribunal aberto não era algo que eu gostei.
Quando iniciamos nossos negócios atuais, os parceiros concordaram que todos os registros fixos (email, mensagens de texto, correio de voz, arquivos no repositório SVN, registros de trabalho no rastreador de tempo etc.) seriam considerados "voltados para o cliente" o tempo todo - até se eles nunca foram destinados a acabar nas mãos dos Clientes. Isso tem sido difícil de fazer e exige muita disciplina, mas acho que vale a pena. Certamente queremos projetar um ar de profissionalismo para nossos Clientes, e viver é a maneira de fazê-lo. Eu certamente nunca ficarei envergonhado como se estivesse naquele tribunal novamente.