DS & II

Capítulo 05 - Documentação de Casos de Uso

Leitura de 3 min

🚀 Capítulo 05: Documentação de Casos de Uso (Tema: Batman)

NOTE

Este capítulo utiliza a temática de Batman para explicar a documentação. Um diagrama sem texto é como um plano do Batman sem detalhes: não funciona!

1. 🎯 Objetivo da Aula

Aprender a documentar um caso de uso, detalhando o fluxo principal, fluxos alternativos e pré-condições.

2. 🏢 O Cenário Prático (Seu Desafio)

O Batman tem um diagrama de casos de uso para o sistema do Batcomputador. Um dos casos de uso é Prender Vilão. No entanto, o Robin não sabe o que fazer se o vilão escapar ou se o Batmóvel quebrar no caminho! Seu desafio é documentar o passo a passo (o roteiro) desse caso de uso para que a equipe saiba agir em qualquer situação.

3. 🧠 Fundamentos: A Teoria Traduzida

O diagrama de elipses e bonecos é ótimo para dar uma visão geral, mas ele não explica o como. Para isso, usamos a Documentação de Caso de Uso.

📋 Estrutura Básica de uma Documentação:

  • Nome do Caso de Uso: Ação (verbo no infinitivo).
  • Ator Principal: Quem inicia a ação.
  • Pré-condições: O que precisa ser verdade antes de começar (ex: O Batman precisa estar no Batmóvel).
  • Fluxo Principal (Caminho Feliz): O passo a passo perfeito, onde tudo dá certo.
  • Fluxos Alternativos / Exceções: O que acontece se algo der errado ou se houver um caminho diferente.

4. 📖 Exemplo Guiado: Documentando “Prender Vilão”

  • Caso de Uso: Prender Vilão
  • Ator: Batman
  • Pré-condição: Localização do vilão identificada.
  • Fluxo Principal:
    1. Batman chega ao local.
    2. Batman rende o vilão.
    3. Batman chama a polícia de Gotham.
    4. Polícia leva o vilão para o Asilo Arkham.
  • Fluxo Alternativo (O Vilão reage):
    • No passo 2, se o vilão atacar, Batman usa gás lacrimogêneo e volta ao passo 3.

5. 🛠️ Prática Obrigatória 1: Documentando a Batcaverna

Crie a documentação para o caso de uso Abrir Portão da Batcaverna.

  • Ator: Batman.
  • Pré-condição: Batman dirigindo o Batmóvel.
  • Escreva um Fluxo Principal com pelo menos 3 passos.
  • Escreva um Fluxo Alternativo (ex: E se o leitor de retina falhar?).

6. 🛠️ Prática Obrigatória 2: Importância do Fluxo Alternativo

Por que é importante mapear os fluxos alternativos antes de começar a programar o sistema? (Pense no que acontece com o software se o usuário fizer algo inesperado).

7. 📤 Instruções de Entrega (GitHub Desktop + Microsoft Teams)

  1. Faça o Commit: No GitHub Desktop, digite a mensagem (ex: Finaliza Capítulo 05 UML) e clique em Commit to main.
  2. Envie para a Nuvem (Push): Clique em Push origin.

8. 📂 Estrutura de Pastas

extra_guia_de_modelagem_uml/
├── capitulos/
│   ├── capitulo_05_doc_uc.md
│   └── codigos/
│       └── cap05/
│           └── doc_batcaverna.txt

9. 💡 Checkpoint de Lógica

Um caso de uso pode ter mais de um fluxo alternativo? Dê um exemplo baseado no cenário do Batman.

10. 🔥 Desafio de Fixação

Pesquise o que são as Pós-condições na documentação de um caso de uso.

11. 🔑 Gabarito de Código/Fórmulas

Resposta da Prática 2: Mapear os fluxos alternativos evita que o sistema trave (crash) quando ocorrem erros, permitindo que o programador crie tratamentos de exceção (como try/catch).

← Capitulo Anterior | Proximo Capitulo →

Visão de gráfico

Backlinks