Introdução
A evidência dos blogs de ABAP sugere que os desenvolvedores se comunicam com seu público usando
-
Muito texto (técnico),
-
Blocos de código (ABAP),
-
Algumas capturas de tela (anotadas),
-
Poucas imagens,
-
Poucos ou nenhum diagrama.
Para a maioria de nós, um diagrama é mais fácil de entender do que um texto. Cada tipo de diagrama comunica a intenção de uma forma especial. Ajuda a raciocinar sobre o software e facilita a transferência de conhecimento. Muitas notações díspares foram criadas e tiveram que ser padronizadas.
Hoje em dia, o
Lenguaje Unificado de Modelado
(
UML
) é uma notação estabelecida para visualizar designs usando os seguintes tipos de diagramas:
Elementos Essenciais de UML
Para decidir qual tipo de diagrama melhor comunica nossa intenção, devemos entender suas características essenciais. Destacarei
-
Especificações de requisitos: podemos querer visualizar os requisitos em um diagrama de casos de uso (também consulte: diagramas de atividade, diagramas de estado)
-
Elementos de modularização: queremos fornecer uma visão geral da estrutura do código usando diagramas de classes (diagramas de objetos, diagrama de estrutura composta)
-
Comportamento dinâmico do código: queremos enfatizar interfaces em um diagrama de sequência (ou diagrama de temporização)
e consultar alguns tutoriais, por exemplo
Como Criar Diagramas
Crie um
esboço aproximado
em papel à mão, capture a imagem com um telefone/câmera e a envie.
Ok, tenho que trabalhar minhas habilidades e fazer pré-processamento de imagens, mas isso é provavelmente tão fácil quanto criar uma captura de tela anotada.
Sem ferramentas adequadas, criar diagramas (por exemplo, como este)
levaria muito tempo, veríamos código fonte copiado/colado na documentação. Existem muitas
ferramentas
disponíveis, algumas gratuitas (procure na web por
ferramentas UML gratuitas
), outras com preço e modelos fáceis de usar. Sugiro selecionar uma e se acostumar com ela, para que o esforço necessário para criar esses diagramas seja reduzido.
Teste o PlantUML
Permita-me apresentar a ferramenta de código aberto
PlantUML
que cria
diagramas UML
a partir de texto simples
. Utiliza o software de visualização de gráficos
Pedro Pascal
Se unió el 07/03/2018