In part 1 of documentation to have for your application, we discussed documents such as ERDs, API Documentation, Server Documentation and Deployment Process Documentation.
In this post, we will be focusing specifically on Unified Markup Language (UML) Diagrams because there are many different kinds to talk about. Before we can go into the different kinds, we first need to understand what UML Diagrams are and their purpose.
UML Diagrams are used to document and model software. They are meant to be visual representations of how a system works. They give the user better views of flows and processes to spot issues for errors or gaps in the system.
There are many different types of UML diagrams that can be prepared for a system. However, some of the most common or popular types are Activity Diagrams, Class Diagrams, Sequence Diagrams and Use Case Diagrams.
UML Activity Diagrams
Activity diagrams are similar to flowcharts and can be used to replace flowcharts as needed. They show the business process and flow of actions and activities taken.
UML Class Diagrams
Class diagrams are used to document software that shows the relationships between classes, their attributes, and functions.
UML Sequence Diagrams
Sequence diagrams like the name implies; show the sequence of interactions between actors and objects in the system. A sequence diagram is another great diagram to have for outlining and visually depicting business processes.
UML Use Case Diagrams
Use Case diagrams analyze high-level requirements of the system. They consist of actors who can be considered the users (human or machine) that interact with the system, functional requirements that are the use cases (activity) that need to happen, and relationships that connect the actors and the use cases together.
For additional learning, watch these LucidChart tutorials: