◇ OpenCyber Academy
Técnico · Capítulo 14 · Português

Capítulo 14 — Documentação simples

Ensino gratuito e aberto para quem deseja proteger pessoas e tecnologias. Não é preciso criar uma conta para estudar ou consultar as respostas.

Capítulo 14 — Documentação simples

Mapa da aula

Aula 14 publicada. Mapa, exemplo, EX053.

flowchart TD
  N0["14.1 Por que documentar"]
  N1["14.2 Redação das instruções"]
  N2["14.3 Registros de mudanças"]
  N3["14.4 Guarda dos documentos"]
  N0 --> N1 --> N2 --> N3
  N3 --> EX["Exemplo resolvido"]
  EX --> Q["Exercício EX053"]

Desenho lógico

flowchart LR
  N0["14.1 Por que documentar"]
  N1["14.2 Redação das instruções"]
  N2["14.3 Registros de mudanças"]
  N3["14.4 Guarda dos documentos"]
  N0 --> N1 --> N2 --> N3 --> Q["EX053"]

[14.1 Por que documentar]
    |
    v
[14.2 Redação das instruções]
    |
    v
[14.3 Registros de mudanças]
    |
    v
[14.4 Guarda dos documentos]
    |
    v
[Exemplo resolvido] --> [Exercício EX053]

Objetivos de aprendizagem

Você vai (1) escrever instruções simples que outras pessoas consigam seguir; (2) manter registros das mudanças; (3) guardar os documentos onde possam ser encontrados.

14.1 Por que documentar

O Sr. Doyle é a única pessoa de TI da Westfield. Quando ele está de férias, a empresa de suporte e os gerentes dos centros precisam saber como as coisas estão configuradas. Chloe aprende que uma documentação simples, escrita com clareza, permite que outras pessoas ajudem quando o responsável habitual está fora. O Sr. Appiah explica que a documentação é um controle de segurança, porque os erros acontecem quando as pessoas adivinham como os sistemas funcionam e mudam a configuração errada. Chloe pergunta ao Sr. Doyle sobre quais tarefas a empresa de suporte mais liga para ele quando está fora. Ele cita três, e ela decide documentá-las primeiro, porque ajudariam mais gente.

14.2 Redação das instruções

Chloe escreve instruções passo a passo para três tarefas: configurar um tablet novo, redefinir o código de um funcionário do caixa e verificar que o backup noturno rodou. Cada uma tem um título, a finalidade, passos numerados com capturas de tela e o que fazer se algo der errado. Ela pede a uma gerente de centro que siga as instruções do tablet. A gerente trava num passo, por isso Chloe acrescenta uma captura de tela que faltava. Ela aprende que o melhor teste das instruções é outra pessoa usá-las. Depois disso, a gerente conclui a tarefa sem ajuda.

14.3 Registros de mudanças

Chloe inicia um log de mudanças simples para a Westfield: data, o que mudou, por quê, quem fez a mudança e como desfazê-la. Ela registra a troca da senha do roteador, as mudanças de permissão das pastas e a separação da rede sem fio de visitantes. O Sr. Doyle acha o log útil quando uma gerente de centro pergunta por que não consegue mais ver a pasta das faturas. O log responde à pergunta em segundos. Ela acrescenta uma coluna que mostra se cada mudança foi testada depois e a preenche para as mudanças feitas até então. O Sr. Doyle decide continuar usando o log depois do estágio e pede à empresa de suporte que registre nele também as mudanças dela.

14.4 Guarda dos documentos

Chloe guarda as instruções e o log de mudanças numa pasta compartilhada que os gerentes e a empresa de suporte podem abrir, mas não os clientes nem as contas dos caixas. Ela evita escrever senhas nos documentos e remete ao gerenciador de senhas. Ela acrescenta uma data e um responsável a cada documento. O Sr. Appiah observa que os documentos sem data deixam os leitores sem saber se ainda estão corretos. Ela cria um documento de índice que lista cada instrução, sua finalidade, seu responsável e sua data, para que o leitor encontre depressa a instrução certa. O Sr. Doyle confere as permissões da pasta e confirma que apenas os gerentes e a empresa de suporte conseguem abri-la.

Exemplo resolvido

Chloe escreve e testa três conjuntos de instruções, inicia um log de mudanças que responde à pergunta de uma gerente e guarda documentos datados e sem senhas.

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

Erros e limites

Escrever senhas nos documentos as expõe a todos os leitores.

Exercícios

Continue estudando — aula 14 (capítulo 14 de 18)

← Capítulo 13 · Índice das aulas · Capítulo 15 →

Continue para a próxima aula já escrita.