Consultoria: Organizando documentação do site / ambiente para os clientes? [fechadas]

12

Com o tempo, assumi consultoria e engenharia de contrato para vários clientes. Mais recentemente, os clientes estão solicitando certos tipos de documentação.

  • Quais endereços IP estáticos posso usar para o novo relógio de ponto da rede que estamos instalando?
  • Como coloco uma exclusão no filtro da web? O CEO não pode mais acessar o site da NRA !!
  • Precisamos desligar o servidor Linux para uma queda de energia planejada. Qual é o comando mesmo?

Essas são pequenas empresas e normalmente não possuem equipe técnica dedicada. Dentro de uma única empresa, Wiki / Confluence / Sharepoint, etc., todos fazem sentido como repositório central de informações de documentação e ambiente, mas luto por encontrar um método consistente para fornecer essas informações a clientes distintos .

Estou buscando um processo que seja mais portátil, seguro e elegante do que uma planilha simples ou o temível fichário cheio de informações desatualizadas .

  • Endereços IP importantes, escopo DHCP, etc.
  • Diagrama de rede (se necessário).
  • Nomes de usuário e senhas administrativos e URLs de gerenciamento.
  • Chaves de licença de software.
  • Contratos de suporte e informações de garantia.
  • Contatos e instruções de suporte ao fornecedor.

Eu sei que existem outros consultores aqui. Alguma sugestão ou dica sobre como manter a documentação em vários ambientes em um formato amigável ao cliente? Como você faz isso?

ewwhite
fonte

Respostas:

12

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.

Evan Anderson
fonte
1
Excelente resposta. Embora eu não seja consultor e trabalhe para apenas uma grande empresa, concordo com a maioria das coisas. Eu acrescentaria que um banco de dados de ativos que preenche itens como DNS, monitoramento, fantoches etc. também pode ser uma coisa boa, mas não armazene informações nele que você não usa, ou ficará desatualizado e sem utilidade.
Dennis Kaarsemaker
Que tipo de software você usa para gerar esses relatórios ao vivo? E quanto a locais físicos, diagramas de failover etc.?
Steve Butler
@SteveButler - Quando me libertar um pouco, expandirei o que você está perguntando, além de direcionar a edição para a pergunta. Há menos de mim para dar a volta do que nunca ...> smile <
Evan Anderson
2

Para informações básicas como você está descrevendo (com exceção de um diagrama de rede), usamos uma única pasta de trabalho do Excel e as salvamos em uma pasta de rede com o nome do cliente. Embora eu possa entender por que as pessoas não gostam dessa abordagem, acho que funciona muito bem porque é um documento de referência único que posso levar comigo para o site, enviar e-mail e atualizar rapidamente.

Minha maior reclamação seria a falta de controle de versão, mas ainda não encontrei nada que funcione bem sem tornar a vida difícil.

Para combater o seu "Estou filmando por um processo mais portátil, seguro e elegante do que uma simples planilha":

Mais portátil: o que pode ser mais portátil que uma planilha de 500 kilobytes? Eu ficaria com medo de usar qualquer coisa na nuvem ou na Web porque a conectividade com a Internet não pode ser garantida.

Seguro: Este é o que darei a você e também gostaria de soluções para tornar nossa solução mais segura.

Elegante: gastamos tempo criando um bom modelo para nossa pasta de trabalho. Como eu disse, esta é uma pasta de trabalho de várias folhas, não apenas uma página enorme de informações dispersas. Acho que a maioria da documentação de TI se encaixa perfeitamente em um formulário tabular e uma planilha mantém isso muito limpo e simples.

Embora eu tenha muitos problemas com a forma como registramos e armazenamos a documentação da compilação, realmente não consigo encontrar falhas em uma planilha sólida e bem formatada. Acrescentarei também que trabalhamos com algumas grandes empresas de serviços de TI e elas funcionam da mesma maneira. Novamente, é brilhante - eu chego ao site, solicito a documentação e obtenho uma única planilha que eu possa usar durante todo o período.

Dan
fonte
2

A grande vantagem desse temível fichário é:

  • Clientes não técnicos podem entendê-lo, mantê-lo no local e mantê-lo seguro, como estão acostumados e já fazem com todos os tipos de documentos importantes.
  • Seus clientes podem entregá-lo facilmente, caso eles contratem um substituto para você, algo profissional a ser feito e algo que lhe daria um rápido início e referência quando você os colocasse como clientes.
  • Um simples registro de manutenção no início, com os destaques de cada visita ao local, é algo tangível.
  • O fichário também possui CD / DVD e certificados com códigos de licença e chaves de ativação, caso a BSA ou outro fornecedor o visite.

Qualquer sistema digital usado não importa mais, desde que você se disciplina para atualizar o fichário sempre que fizer algo que valha a pena.

E, obviamente, o fichário é completamente inútil para você se você fizer quase todo o seu suporte remotamente.

Eu sou um grande fã do uso de um wiki, pois ele é facilmente mantido, são facilmente seguidos os links para interfaces da OIT e de gerenciamento, desktop remoto e logins SSH. A forma livre combina com a maioria das informações que eu gostaria de ter:

  • descrição do site: "a impressora de rede (OKI 1234 MFP) é a próxima à mesa de John, a impressora a jato de tinta modelo 0123 fica em Bobs, o escritório do chefe" torna muito mais fácil atender uma ligação: "nós ficar sem tinta, qual cartucho devemos pedir novamente? ".

  • página para cada dispositivo, idealmente com uma imagem, tipo e configuração, finalidade, etc.

  • Existem alguns módulos de exportação decentes para os Wiki gerarem documentos impressos ou digitais para entrega e inclusão nesse temível fichário

HBruijn
fonte
Bons pontos. Sou remoto para 90% dos meus clientes, mas viajo com frequência. Você sugeriria um wiki central que eu hospede versus algo local?
ewwhite
Quando você hospeda o wiki, fica muito mais fácil configurá-lo para sincronizar com seu laptop, o que pareceria prudente quando você viaja com frequência.
HBruijn
0

Concordo que Dan no Excel seja uma solução boa e portátil e acho que ele é um excelente argumento, exceto na parte de segurança em que acho que as preocupações são um pouco mal direcionadas:

Qualquer que seja o método com o qual você deseje distribuir, uma solução segura pode ser coberta (por exemplo, email criptografado, armazenamento compartilhado seguro etc.). O mesmo vale para o controle de versão (por exemplo, cópias de sombra, svn etc.).

No entanto, apenas por meio de críticas construtivas e com todo o respeito, acrescentaria que uma grande desvantagem de uma planilha compartilhada do Excel são suas limitações de simultaneidade. No dia em que você tem dois administradores ou mais, eles consideram um problema real ser forçado a escolher entre apenas um de cada vez ser capaz de abrir a planilha para edição ou ter várias cópias salvas que precisam ser mescladas (quais dados são atualizado e o que não é?). E é realmente uma dor.

Uma solução melhor é usar o Excel (ou o que você desejar) como interface para um pequeno banco de dados de escolha, seja o Access (apenas para endereçar a portabilidade), MS SQL, MariaDB ou o que você quiser.

Defendo isso como uma solução que não é apenas adequada para passar informações para outra parte (= Excel), mas que também é adequada para manter um esforço de documentação contínua.

Minha opinião, em resumo, é que, mesmo com apenas alguns administradores (para não mencionar lojas maiores), um departamento que depende do Excel para armazenamento de dados de documentação é um departamento com uma documentação extensa. Nunca vi uma exceção, a menos que haja apenas um administrador.

Mas um departamento que usa armazenamento orientado a banco de dados tem a oportunidade de manter uma documentação rígida e atualizada. É então apenas uma questão de esforço. Um Excel é uma interface de banco de dados viável, com prós e contras, mas de maneira alguma a única opção.

ErikE
fonte
Lembre-se de que isso é para uma situação de consultoria, com vários clientes. Não haverá problemas de simultaneidade.
ewwhite
0

Pode não ser exatamente o que você está procurando, mas aqui está o que eu faço.

Eu uso o Microsoft Office para criar todos os documentos para cada um dos meus clientes. Uso o Excel (informações de endereço IP, mapeamento de portas do switch, layout de rack), Word (informações de configuração, faturas, modelos SOW) e Visio (diagramas). Crio uma hierarquia de pastas com a pasta pai denominada Consulting e uma pasta filha denominada para cada cliente. Ao criar ou atualizar documentos do cliente, sincronizo-os com o meu iPhone (usando o Documents To Go ), o pen drive USB e a conta DropBox (usando a autenticação de dois fatores). Dessa forma, tenho acesso a toda a documentação (de uma maneira ou de outra) em qualquer lugar e em qualquer lugar que eu vá.

Eu também uso um aplicativo de gerenciamento de projetos / relatórios / faturamento / rastreamento de tempo chamado OfficeTime . Há um aplicativo para iPhone e um aplicativo complementar para Windows, por isso tenho acesso a informações sobre projetos, faturamento, horas etc. no meu iPhone quando estou no local e sincronização com minha área de trabalho quando chego em casa.

joeqwerty
fonte
0

Embora essa não seja uma solução perfeita, você deve dar uma olhada no Device42 .

Aqui está o que você pode fazer: IPs e dispositivos podem ser associados aos clientes. E você pode ter grupos VRF para sobrepor faixas de IP em vários clientes.

Ele não possui permissão granular para IPs / Dispositivos (apenas acesso global baseado em função), portanto, você não pode permitir o acesso direto dos clientes finais. Mas você pode criar relatórios por cliente com informações de dispositivo e IP e enviá-lo ao cliente final sempre que necessário.

Isso pelo menos fornecerá uma interface para organizar todas as informações em um repositório central. Você pode armazenar informações de ativos, informações de IP, informações de contrato e senhas.

Além disso, ele fornece mais informações nas chamadas da API REST, mas não tem certeza se você pode conectar algo para clientes individuais com base nisso.

Sonu Bansal
fonte
Não é um ajuste, mas uma plataforma interessante de gerenciamento de ativos para ambientes maiores.
ewwhite
1
Concorde, não é um ajuste perfeito com base nas suas necessidades. Fiz uma solicitação de recurso para adicionar acesso baseado em função com base nos clientes. Funciona bem para nós, provedores de serviços em nuvem, rastrear todos os equipamentos de clientes e endereços IP, mas também gostaríamos de fornecer acesso ao portal para os clientes para que eles possam acessar suas informações.
Sonu Bansal