OpenCyber Academy
Engenharia · Capítulo 5 · Português
Código do curso: OCA-133Capítulo 05: OCA-133-C005

Capítulo 5 — Comunicação em engenharia

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

Mapa da aula

Aula 05 publicada. Mapa, exemplo, EX013.

flowchart TD
  N0["5.1 Escrever para a decisão do leitor"]
  N1["5.2 Fato, suposição, julgamento"]
  N2["5.3 TLP em documentos"]
  N3["5.4 Figuras"]
  N4["5.5 Revisão"]
  N5["Nota de prática — Formas curtas"]
  N6["Síntese"]
  N0 --> N1 --> N2 --> N3 --> N4 --> N5 --> N6
  N6 --> EX["Exemplo resolvido"]
  EX --> Q["Exercício EX013"]

Desenho lógico

flowchart LR
  N0["5.1 Escrever para a decisão do leitor"]
  N1["5.2 Fato, suposição, julgamento"]
  N2["5.3 TLP em documentos"]
  N3["5.4 Figuras"]
  N4["5.5 Revisão"]
  N5["Nota de prática — Formas curtas"]
  N6["Síntese"]
  N0 --> N1 --> N2 --> N3 --> N4 --> N5 --> N6 --> Q["EX013"]

[5.1 Escrever para a decisão do leitor]
    |
    v
[5.2 Fato, suposição, julgamento]
    |
    v
[5.3 TLP em documentos]
    |
    v
[5.4 Figuras]
    |
    v
[5.5 Revisão]
    |
    v
[Nota de prática — Formas curtas]
    |
    v
[Síntese]
    |
    v
[Exemplo resolvido] --> [Exercício EX013]

Objetivos de aprendizagem

Você vai (1) escrever requisitos, notas de projeto e resumos de incidentes em linguagem simples; (2) separar fatos, suposições e julgamentos, como recomenda a ICD 203; (3) aplicar rótulos TLP a documentos de engenharia; (4) escolher figuras que reduzam a confusão, em vez de aumentá-la.

5.1 Escrever para a decisão do leitor

Todo documento responde a uma pergunta do leitor. Um requisito responde "o que o sistema deve fazer?". Uma nota de projeto responde "por que deste jeito?". Um resumo de inteligência responde "o que devo fazer agora?". Comece pela resposta e depois a sustente. Um analista que lê um resumo no início do turno quer saber se deve bloquear, observar ou ignorar. Se essa resposta estiver enterrada no quarto parágrafo, o leitor pode agir com base na errada. Kofi põe a ação recomendada na primeira frase e a evidência abaixo dela, para que um leitor que pare cedo ainda aja corretamente e um que continue lendo possa conferir o raciocínio.

5.2 Fato, suposição, julgamento

"O feed do Parceiro A entregou 12.000 indicadores ontem" é um fato. "O feed do Parceiro A é, em sua maioria, atual" é uma suposição, a menos que seja medida. "Devemos priorizar o Parceiro A para bloqueio automatizado" é um julgamento. Os padrões de ofício analítico da ICD 203 pedem que quem escreve distinga informação de suposições e julgamentos; os engenheiros se beneficiam da mesma disciplina. Kofi marca cada tipo em seus rascunhos. Um fato traz sua fonte e data, uma suposição diz o que a confirmaria, e um julgamento declara quem o fez. Assim os leitores podem contestar a coisa certa.

5.3 TLP em documentos

Uma nota de projeto que contém nomes de parceiros sob um acordo de compartilhamento AMBER herda essa restrição. Coloque o rótulo TLP 2.0 no cabeçalho e no rodapé. Documentos sem rótulo tendem a se espalhar. O modelo de Kofi põe o rótulo nos dois lugares, para que uma página impressa ainda o mostre. Um documento que mistura materiais deve levar o rótulo mais restritivo entre suas partes, ou ser dividido para que a parte mais ampla possa circular mais longe. Os nomes dos parceiros costumam ser o elemento restrito, e substituí-los por um identificador neutro pode permitir que o resto seja compartilhado.

5.4 Figuras

Um único gráfico de tempo até o bloqueio por fonte é mais claro que um painel de vinte medidores. Rotule os eixos com unidades; informe o período e a fonte dos dados na legenda. Kofi testou com o turno da noite um painel de muitos medidores e descobriu que ninguém conseguia dizer qual fonte era a mais lenta. Um único gráfico de barras ordenado pela mediana do tempo até o bloqueio respondeu isso em segundos. Cada gráfico que ele publica agora tem uma legenda com o período, a fonte dos dados e a unidade, para que o leitor possa julgar se uma mudança é real ou resultado de uma medição diferente.

5.5 Revisão

Peça a um revisor que repita seu ponto principal em uma frase. Se ele não conseguir, reescreva. Kofi faz isso com um colega antes de enviar qualquer nota de projeto. Quando o colega descreveu sua nota sobre enriquecimento como sendo sobre logs, ele percebeu que a conclusão estava no último parágrafo. Movê-la para o topo resolveu o problema. Uma segunda verificação é perguntar que ação o leitor deve tomar; se o revisor não souber dizer, a nota não tem um pedido claro. As duas verificações levam poucos minutos e poupam os leitores de um documento confuso.

Nota de prática — Formas curtas

Executivos leem o primeiro parágrafo e a figura. Analistas leem a tabela de indicadores. Engenheiros leem o registro de decisão. Kofi escreve cada documento com um resumo de três linhas no topo — decisão, motivo, prazo —, para que todo leitor possa parar cedo sem perder a ação que lhe cabe.

Exemplo resolvido

Kofi redige uma nota recomendando um segundo worker de enriquecimento. O primeiro rascunho abre com três parágrafos de histórico. Ele reescreve: "Acrescentar um worker de enriquecimento antes de 1º de março; o atraso da fila passou de 10 minutos em 9 de 30 dias (fato). Supomos que o volume cresça 20% este ano (suposição)." O gestor aprova em uma única leitura.

Caso sintético. A nota e os números são inventados.

Erros e limites

Rotular tudo como RED impede o compartilhamento necessário; rotular de menos vaza informação. Linguagem simples não é o mesmo que linguagem vaga.

Exercícios

Síntese

Responda primeiro, separe fato de suposição e julgamento, rotule a sensibilidade e faça cada figura trazer suas unidades e sua fonte.

Continue estudando — capítulo 05 de 50

← Capítulo 04 (rascunho) · Índice de capítulos do curso · Capítulo 06 (rascunho) →

Respostas comentadas

EX013. A frase sobre a fila é um fato medido; o crescimento de 20% é uma suposição sobre o futuro.

EX014. Pelo menos TLP:AMBER, herdado do acordo que cobre os nomes de parceiros citados.

EX015. A métrica e suas unidades, o período coberto e a fonte dos dados.