Skip to main content
29 votes
Accepted

How to visualize the design of a physics engine?

TO DO lists are wonderful things. I'm not talking about // #TODO: blah blah comments. I mean get an honest to God notebook. You never know when you'll remember something important to do. A notebook ...
candied_orange's user avatar
13 votes

What is a proper diagram to describe software architecture

What is the purpose of the layers ? The clean architecture aims to achieve separation of concerns, by dividing the software into concentric layers. The main difference compared to the traditional ...
Christophe's user avatar
  • 78.4k
9 votes

Draw a Call Graph

I think a call graph would be the most appropriate visualization. If you decide not to do it by hand, there's a nice little tool called pyan that does static analysis on a python file and can generate ...
seren's user avatar
  • 199
8 votes

How to visualize the design of a physics engine?

"Everything should be built top-down, except for the first time", they say. I'd start from the lowest level (e.g. basic vector math), and made sure I understand it well and it has a good test ...
9000's user avatar
  • 24.3k
7 votes

How to depict the relationship between a Back-End and a DB in a component diagram?

Your confusion comes probably from the fact that databases, especially normalized relational databases, when seen as a component, typically provide very broad interfaces. Any public table, any view ...
Doc Brown's user avatar
  • 209k
7 votes
Accepted

How do you correctly turn this text into an activity diagram (problem with timer)?

Problem Your diagram has several flaws. For instance, you'd need a join to synchronize the camera recording and the timer. But then, the semantic would mean that both activities must be finished ...
Christophe's user avatar
  • 78.4k
7 votes
Accepted

How to show relationships of the component containing the interface definition when using ball/socket notation in a UML Component Diagram?

The goal of a component diagram is not the same than a class diagram. Nor is it an alternative to package diagrams. The focus of component diagrams is on self-standing, replaceable components, and ...
Christophe's user avatar
  • 78.4k
7 votes
Accepted

Why Don't We Add `Attributes` To Use Case Diagrams?

When talking about Use Case Diagrams, I like to make sure to mention one or two quotes from Martin Fowler's UML Distilled: The best way to think of a use case diagram is that it's a graphical table ...
Thomas Owens's user avatar
  • 83.3k
7 votes
Accepted

When is a "port" used in UML component diagram?

Figure 11.46 in the UML 2.5 specifications is a better example: you’ll find on the same diagram: a port of the component Order is used with an external interface, AccountPayable, that is connected ...
Christophe's user avatar
  • 78.4k
7 votes

Drawing numbers for software engineering documents?

You may see that in some regulated contexts, but probably not on a per-diagram level. When I worked in aerospace, architectural and design documents were controlled. Prior to new releases entering the ...
Thomas Owens's user avatar
  • 83.3k
6 votes
Accepted

Should we include external services in a deployment diagram

In the UML specification, Section 11 describes component diagrams and Section 19 describes deployment diagrams. There's nothing that says that you can or can't include external systems, services, or ...
Thomas Owens's user avatar
  • 83.3k
6 votes

What is a proper diagram to describe software architecture

Consider Simon Brown's C4 model. In summary (from Wikipedia), Context diagrams (level 1): they show the system in scope and its relationship with users and other systems; Container diagrams (level ...
ximiki's user avatar
  • 345
6 votes
Accepted

Is there a name for these diagrams that show the flow of a valid value

They are called railroad diagrams or syntax diagrams. Syntax diagrams (or railroad diagrams) are a way to represent a context-free grammar. They represent a graphical alternative to Backus–Naur ...
Toon Krijthe's user avatar
  • 2,634
6 votes

Drawing numbers for software engineering documents?

Not really; the drawings tend to be informational rather than definitive, whereas in engineering the drawings are the work product. Software engineering however makes much more extensive use of ...
pjc50's user avatar
  • 13.7k
6 votes
Accepted

Required sequential actions in use case diagram

What you are doing (and it's a typical mistake at the beginning) is decomposing how to execute a single use case as "smaller use cases". As a result you're getting a messed diagram with a ...
Ister's user avatar
  • 849
5 votes

Are there different symbols for "database server" vs "database"?

This is the symbol for a Database: This is the symbol for a Database Server:
Robert Harvey's user avatar
5 votes
Accepted

use case diagrams - need we add validations?

I don't think it would appear in a use case diagram. Although a use case is a series of steps in an interaction between a user and the system, the thing that appears in a use case diagram is really ...
Thomas Owens's user avatar
  • 83.3k
5 votes
Accepted

Is there a UML diagram for functional programming?

In short Yes and no! Yes you can model it! The UML activity diagram models control flow and object flow. Both are very practical to model individual functions, function composition, and function ...
Christophe's user avatar
  • 78.4k
5 votes
Accepted

UML Use Case Diagrams Relationship - Required / Optional AND independent

Use-cases are not intended to have any sequencing between them. Use-cases are meant to represent interactions with the system that are of value for the actors (i.e. use cases correspond to goals ...
Christophe's user avatar
  • 78.4k
5 votes
Accepted

Does UML have a grammar that correlates to its diagrams?

The UML language for creating models is defined using a meta-model, which is itself described using a sub-set of UML. This means that the official specification of UML uses UML diagrams to show which ...
Bart van Ingen Schenau's user avatar
5 votes

Mixing up UML and non-UML diagrams

Design documentation is meant for people. Machines don't care. People care because these documents help them build the system or maintain it. Worse case scenario, the documents are a box-ticking ...
Greg Burghardt's user avatar
4 votes

How to visualize the design of a physics engine?

Make diagrams of the architecture! The OpenGL pipeline diagrams FrustratedWithFormsDesigner posted in the comments are a great example for program flow, but that’s only one type of diagram that can be ...
9999years's user avatar
  • 149
4 votes
Accepted

Software Requirement Specification and diagrams

To me, the fundamental objective of the SRS is to tell the software team what the software is supposed to do. This is an alternative to just making it up as you go along (aka "agile"). If you're ...
Simon B's user avatar
  • 9,633
4 votes
Accepted

Choice of appropriate UML diagram during Analysis phase

The behaviors of a system are usually captured in UML with use case (requirements), sequence diagrams (interaction scenario between several classes), or activity diagrams (logical internal flow). The ...
Christophe's user avatar
  • 78.4k
4 votes
Accepted

Object Instance Diagram - What can be modeled?

Association and Composition make sense for objects, as well as classes. An object may use another (Association), and an object may contain another (Composition). But you can only Generalize a base ...
Simon B's user avatar
  • 9,633
4 votes
Accepted

How should I make it less scary for a team to create diagrams?

This really requires a two pronged approach: automated tools, as Ewan suggests, along with including updates to these diagrams as part of the scope of work. Automated tools will catch the low hanging ...
Greg Burghardt's user avatar
4 votes

Should I be attaching diagrams, wire frames and other design artifacts to User Stories in an agile approach?

YOUR TEAM must know what is good for YOUR TEAM The amount of detail the user tasks should have are team dependent. In that sense, it is not possible to know if for YOUR TEAM it will be good to attach ...
ianmandarini's user avatar
  • 2,818
4 votes
Accepted

How to document a concurrent communication protocol for less theoretical people

UML sequence diagram detailing the basic happy path Yes! That sounds exactly right. If you're going for least-common-denominator, "anyone" could follow this, then maybe incorporate step1, ...
J_H's user avatar
  • 7,338

Only top scored, non community-wiki answers of a minimum length are eligible