Capítulo 27 — Documentação e passagem de serviço

Capítulo 27 — Documentação e passagem de serviço

Mapa da aula

Aula 27 publicada. Mapa, exemplo, EX079.

flowchart TD
  N0["27.1 O que documentar"]
  N1["27.2 Plano de passagem de serviço"]
  N2["27.3 Teste pelo uso"]
  N3["27.4 Verificação final"]
  N0 --> N1 --> N2 --> N3
  N3 --> EX["Exemplo resolvido"]
  EX --> Q["Exercício EX079"]

Desenho lógico

flowchart LR
  N0["27.1 O que documentar"]
  N1["27.2 Plano de passagem de serviço"]
  N2["27.3 Teste pelo uso"]
  N3["27.4 Verificação final"]
  N0 --> N1 --> N2 --> N3 --> Q["EX079"]

[27.1 O que documentar]
    |
    v
[27.2 Plano de passagem de serviço]
    |
    v
[27.3 Teste pelo uso]
    |
    v
[27.4 Verificação final]
    |
    v
[Exemplo resolvido] --> [Exercício EX079]

Objetivos de aprendizagem

Você vai (1) documentar sistemas e controles para outras pessoas; (2) preparar uma passagem de serviço; (3) verificar a documentação pelo uso.

27.1 O que documentar

Jamal documenta o que construiu e alterou: diagramas de rede, modelos de contas, procedimentos, scripts com instruções, agendamentos e a lista de fornecedores. Cada documento indica um responsável e uma data de revisão. A Sra. Grant explica que as equipes de TI pequenas dependem da documentação, porque, quando uma pessoa está ausente, a outra precisa dar conta sozinha. Jamal guarda tudo numa única pasta estruturada com um índice. Ele pede ao gerente de TI que revise o índice e confirme que não falta nada importante. O gerente de TI acrescenta um item: o procedimento de renovação do certificado do site.

27.2 Plano de passagem de serviço

Com o fim do estágio se aproximando, Jamal prepara uma passagem de serviço. Ele lista cada tarefa que executa, com que frequência, qual documento a explica e quem a assumirá. O técnico assumirá a maioria das tarefas; o gerente de TI revisará os resultados. Ele agenda sessões em que o técnico executa cada tarefa com Jamal observando e, depois, sozinho. A Sra. Grant observa que a passagem de serviço é um controle de segurança, porque as tarefas que ficam sem responsável param. Ele mantém uma lista de verificação que mostra cada tarefa, a data em que foi passada e a assinatura do técnico.

27.3 Teste pelo uso

Durante a passagem de serviço, o técnico segue o procedimento de teste de restauração e trava num ponto em que o nome de um servidor mudou. Jamal atualiza o documento. O técnico também descobre que as instruções dos scripts pressupõem conhecimentos que ele não tem. Jamal acrescenta uma breve explicação. Ele aprende que a documentação é testada pelas pessoas que precisam usá-la, e não por seu autor. Depois das mudanças, o técnico segue de novo cada procedimento sem ajuda. Jamal registra a data em que cada documento foi testado e por quem, para que os leitores posteriores saibam que ele foi conferido por um usuário real.

27.4 Verificação final

Jamal verifica que todas as contas que usou estão desativadas ou transferidas, que todas as senhas que conhecia foram trocadas e que seu acesso aos sistemas do Riverbend é removido no último dia. Ele confirma isso com o gerente de TI. A Sra. Grant observa que os funcionários e estudantes que saem também são desligamentos e que seguir o processo de desligamento para si mesmo dá um bom exemplo. Ele também devolve o cartão de acesso ao prédio e confirma que seu nome foi retirado da lista de contatos fora do expediente. O gerente de TI assina a lista de verificação de desligamento, e Jamal guarda uma cópia no caderno.

Exemplo resolvido

Jamal documenta seu trabalho numa pasta com índice, planeja uma passagem de serviço supervisionada, corrige os documentos depois que o técnico os testa e confirma a remoção do próprio acesso.

Caso sintético. Os documentos são sintéticos.

Erros e limites

A documentação testada apenas por seu autor muitas vezes falha com outros usuários.

Exercícios

• EX079 — Quem recebe o serviço. Quem assume a maioria das tarefas? Rubrica: 3 = o técnico;; 2 = parcialmente correto;; 1 = outro;; 0 = nenhuma.

• EX080 — Correção do documento de restauração. O que estava errado no procedimento de restauração? Rubrica: 3 = o nome de um servidor que mudou;; 2 = parcialmente correto;; 1 = vago;; 0 = nenhuma.

• EX081 — O próprio acesso. O que acontece com o acesso de Jamal? Rubrica: 3 = é removido no último dia;; 2 = parcialmente correto;; 1 = vago;; 0 = nenhuma.

Continue estudando — aula 27 (capítulo 27 de 30)

← Capítulo 26 · Índice das aulas · Capítulo 28 →

Continue para a próxima aula já escrita.