Uma atualização do ServiceNow está agendada para o próximo mês. A equipa de plataforma precisa de saber quais as regras de negócio, fluxos e scripts do cliente que poderão ser afetados; os auditores querem evidência de quem pode aprovar alterações; e um novo administrador acabou de se juntar. Toda a gente recorre à documentação e encontra um documento de design do go-live, uma pasta de capturas de ecrã que já não correspondem aos ecrãs e uma grande quantidade de conhecimento que só existe na cabeça de um único consultor.

A documentação de implementação do ServiceNow evita isso. Regista o que foi construído, porquê, como está configurado e como as pessoas o utilizam, para que a plataforma possa ser atualizada, auditada e expandida com segurança. Este guia explica o que a documentação de implementação do ServiceNow deve incluir, como documentar fluxos de trabalho sem capturas de ecrã manuais, como capturar configurações para auditoria, o que documentar em cada fase e como manter tudo atualizado ao longo das atualizações regulares do ServiceNow.

O que é a documentação de implementação do ServiceNow?

A documentação de implementação do ServiceNow é o conjunto de registos que explica uma implementação do ServiceNow: os requisitos e o desenho do processo, a configuração da instância, a configuração e personalização, as integrações, as decisões sobre dados e CMDB, os testes, as versões e os guias que indicam aos agentes, colaboradores e administradores como usar e executar a plataforma. Aplica-se ao ITSM e a outros fluxos de trabalho do ServiceNow, como a entrega de serviços de RH ou o serviço ao cliente.

Os mesmos princípios aplicam-se a outras plataformas empresariais; veja como documentar processos complexos de software empresarial entre SAP, ServiceNow e Salesforce.

Porque é que a documentação de implementação do ServiceNow é importante?

• As atualizações são mais seguras. O ServiceNow lança novas versões duas vezes por ano, e as personalizações documentadas deixam claro o que deve ser testado.

• As auditorias são mais fáceis. Os auditores querem evidência de configurações, controlos de acesso e aprovações de alterações.

• A transição de administradores é menos arriscada. As razões por detrás de cada definição não ficam com a pessoa que a implementou.

• As alterações são mais rápidas. As equipas não precisam de fazer engenharia inversa a uma regra de negócio antes de a alterar.

• A adoção melhora. Os agentes e colaboradores com guias claros utilizam a plataforma conforme foi concebida.

O que deve incluir a documentação de implementação do ServiceNow?

Como documentar fluxos de trabalho do ServiceNow sem capturas de ecrã manuais?

As capturas de ecrã manuais são a forma mais lenta de documentar o ServiceNow. Cada passo implica capturar, recortar, colar e anotar, e cada alteração na interface envia as capturas para fora de data. Uma abordagem baseada em gravação é mais rápida e mais fácil de manter:

1. Grave o fluxo de trabalho uma vez, executando-o na sua instância enquanto narra cada passo, com o gravador de ecrã com IA da Trupeer.

2. Gere o guia automaticamente. A Trupeer transforma a gravação num guia passo a passo com capturas de ecrã e um vídeo narrado.

3. Edite e adicione contexto, como regras de negócio, critérios de aprovação e o que acontece em seguida.

4. Publique onde as pessoas procuram, na sua base de conhecimento ou portal.

5. Atualize editando, e não voltando a capturar, quando um rótulo ou passo muda.

Isto funciona para fluxos de trabalho de agentes, pedidos do catálogo, aprovações e tarefas de administração. Para artigos de conhecimento especificamente, veja as melhores práticas para artigos de conhecimento do ServiceNow.

Como documentar configurações do ServiceNow para auditoria?

Os auditores e as equipas de governação da plataforma precisam de ver o que está configurado, quem o pode alterar e como as alterações são aprovadas. Para documentar configurações do ServiceNow para auditoria:

• Mantenha um registo de configuração para cada personalização, com a sua finalidade, responsável, data e o requisito que cumpre.

• Registe walkthroughs de configurações críticas, como regras de aprovação, controlos de acesso e fluxos de trabalho de alterações, mostrando como funcionam na instância.

• Documente funções e acesso por grupo, com a justificação do negócio para funções privilegiadas.

• Vincule cada alteração à sua aprovação, através dos seus registos de alteração e de versão.

• Crie versões da documentação, para poder mostrar como a configuração era em qualquer momento; veja controlo de versões de SOP.

• Revise regularmente, especialmente antes de auditorias e após atualizações.

O que deve documentar em cada fase de implementação?

Para evidência de testes, veja a lista de verificação de documentação UAT.

Como criar documentação de implementação do ServiceNow passo a passo?

Passo 1: Definir um padrão de documentação

Decida de que documentos precisa, o modelo de cada um, onde vão ficar e quem é o responsável por cada um, antes de começar a construção.

Passo 2: Documentar decisões à medida que desenha

Registe as decisões de desenho com as opções consideradas e a razão pela qual foi escolhida uma delas. O raciocínio é o que os futuros administradores mais precisam.

Passo 3: Registar a configuração à medida que constrói

Adicione todas as personalizações ao registo de configuração à medida que são criadas, e não no final do projeto.

Passo 4: Registar walkthroughs de processos e configurações

Registe administradores a explicar fluxos e regras complexos, e utilizadores-chave a executar tarefas de agentes e colaboradores; depois, transforme as gravações em guias e vídeos.

Passo 5: Criar guias para cada público

Crie guias separados para agentes, aprovadores, colaboradores e administradores. A formação e a documentação para agentes devem andar de mãos dadas; veja as melhores práticas para vídeos de formação do ServiceNow.

Passo 6: Entregar com responsáveis e datas de revisão

No fecho do projeto, atribua um responsável a cada documento e acordar como a documentação é atualizada em cada versão.

Como manter a documentação do ServiceNow atualizada ao longo das atualizações?

• Revise a documentação como parte de cada atualização, juntamente com testes de registos ignorados e de regressão.

• Associe as atualizações da documentação aos registos de alterações, para que nenhuma alteração seja encerrada sem a sua documentação atualizada.

• Atualize os guias editando scripts em vez de voltar a gravar; veja como atualizar um vídeo de formação sem voltar a gravar.

• Desative a documentação de configurações que foram removidas.

• Verifique os guias face à interface atual após cada versão, especialmente para colaboradores e agentes.

A mesma abordagem funciona para outras plataformas de ITSM?

Sim. Quer utilize o ServiceNow, Atomicwork, Freshservice ou outra ferramenta de ITSM, aplicam-se os mesmos princípios: documentar decisões e configurações, registar walkthroughs em vez de capturar capturas de ecrã manualmente, atribuir um responsável a cada documento e atualizar a documentação com cada alteração. Apenas mudam a terminologia e os ecrãs. Para uma visão lado a lado, veja a comparação da documentação das plataformas de ITSM.

Lista de verificação da documentação de implementação do ServiceNow

• Os requisitos e os desenhos do processo são documentados com as razões por detrás das principais decisões.

• A paisagem de instâncias e o processo de promoção são documentados.

• Um registo de configuração cobre todas as personalizações, com finalidade e responsável.

• As funções, grupos e controlos de acesso são documentados e justificados.

• Os itens do catálogo, integrações e decisões sobre CMDB são documentados.

• A evidência de testes e os registos de versões são guardados e associados.

• Os guias para agentes, aprovadores, colaboradores e administradores são publicados.

• Todos os documentos têm um responsável e uma data de revisão.

• A documentação é revista em cada atualização e alteração.

Erros comuns na documentação do ServiceNow

• Documentar o quê, não o porquê, para que ninguém saiba se uma personalização ainda é relevante.

• Confiar em capturas de ecrã manuais que ficam desatualizadas em cada versão.

• Deixar a documentação para depois do go-live.

• Manter documentos em pastas do projeto que ninguém consulta após a passagem de responsabilidade.

• Ignorar os guias para utilizadores finais e agentes, o que prejudica a adoção; veja a nossa estratégia de adoção do utilizador no ServiceNow.

• Nunca atualizar a documentação após as atualizações.

Crie documentação de implementação do ServiceNow com a Trupeer

A Trupeer transforma as gravações da sua instância do ServiceNow em guias passo a passo e vídeos, para que os walkthroughs de configuração, os fluxos de trabalho dos agentes e os procedimentos para colaboradores sejam documentados sem capturas de ecrã manuais e se mantenham atualizados após cada atualização. Veja o IT knowledge base e plataforma de gestão de SOP da Trupeer ou comece gratuitamente com a Trupeer.

Perguntas frequentes

O que é a documentação de implementação do ServiceNow?

É o conjunto de registos que explica uma implementação do ServiceNow: requisitos, desenho do processo, configuração da instância, configuração, acesso, catálogo, integrações, CMDB, testes, versões e guias para agentes, colaboradores e administradores.

O que deve incluir a documentação do ServiceNow?

Requisitos e desenho do processo, a paisagem de instâncias, um registo de configuração, funções e acesso, itens do catálogo, integrações, decisões sobre CMDB e dados, registos de versões e de testes, guias de utilizador e de agente e runbooks do administrador.

Como documentar fluxos de trabalho do ServiceNow sem capturas de ecrã?

Grave o fluxo de trabalho uma vez na sua instância enquanto o narra e utilize uma ferramenta como a Trupeer para transformar a gravação num guia passo a passo com capturas de ecrã e um vídeo; depois, atualize-o editando em vez de voltar a capturar.

Como documentar configurações do ServiceNow para auditoria?

Mantenha um registo de configuração com finalidade, responsável e data para cada personalização, registe walkthroughs de configurações críticas, documente funções e acesso, associe as alterações às aprovações e crie versões da sua documentação.

Com que frequência deve ser atualizada a documentação do ServiceNow?

Com cada alteração que a afete e como parte de cada atualização, uma vez que o ServiceNow lança novas versões duas vezes por ano.

Quem deve ser responsável pela documentação do ServiceNow?

O responsável pela plataforma ou a equipa de administradores do ServiceNow deve ser responsável pela biblioteca, com responsáveis nomeados para cada área de processo e guia.

Qual é a diferença entre documentação de administrador e guias de utilizador?

A documentação de administrador explica como a plataforma é construída e mantida. Os guias de utilizador explicam como os agentes, aprovadores e colaboradores executam as suas tarefas. Ambos fazem parte da documentação de implementação do ServiceNow.

Esta abordagem funciona para Atomicwork ou Freshservice?

Sim. Os princípios são os mesmos para qualquer plataforma de ITSM; apenas mudam a terminologia e os ecrãs.