Artefatos

Anotação de Texto(Text Annotation)

Um comentário livre que adiciona explicações ao diagrama, sem afetar a execução. Aparece como um colchete aberto ligado por associação ao elemento comentado.

A Anotação de Texto (Text Annotation) é um artefato puramente documental: serve para esclarecer regras, exceções ou observações que o restante da notação não expressa. Não interfere no fluxo nem na semântica de execução — é uma nota para quem lê o diagrama.

Liga-se a qualquer elemento por meio de uma Associação (Association) — a linha pontilhada — deixando claro a que a observação se refere.

Quando usar e evitar

Quando usar

  • Para registrar uma regra de negócio ou premissa que o diagrama não consegue mostrar sozinho.

  • Para documentar SLAs, exceções ou condições especiais ao lado de uma atividade.

  • Para orientar leitores menos familiarizados com o processo.

Quando NÃO usar

  • Para substituir modelagem correta — se algo influencia o fluxo, modele com o elemento adequado (gateway, evento etc.).

  • Em excesso: anotações demais poluem e reduzem a legibilidade.

  • Para dados que trafegam no processo — use Objeto de Dados.

Exemplo de negócio

Comentando uma regra de prazo

Diagrama BPMN: Comentando uma regra de prazo
Comentando uma regra de prazo

Abra este exemplo no editor de processos da HEFLO e explore o diagrama por dentro.

Abrir no editor HEFLO →

Passo a passo

  1. A atividade Analisar solicitação tem, ao lado, uma Anotação de Texto (destacada) ligada por associação pontilhada.
  2. A anotação informa a regra “SLA: 48 horas úteis”, que não é parte executável do modelo, mas orienta quem lê.
  3. O fluxo de sequência principal segue inalterado — a anotação é apenas documental.

Diferenças

Text Annotation vs modeled behavior

If the note describes something that *should happen* (a deadline, an escalation), consider modeling it (timer boundary, escalation event) instead — annotations document, they don't execute.

FAQ

A Anotação de Texto altera a execução do processo?

Não. É um artefato documental, sem efeito sobre o fluxo. Serve apenas para comunicar informação a quem lê o diagrama.

Como ligo uma anotação a um elemento?

Por meio de uma Associação — a linha pontilhada — conectando a anotação ao elemento que ela comenta.

Elementos relacionados