application architecture   architecture documentation   architecting  

Understanding an architecture: part 1 - system context

Recently, I was talking with a friend, who is a software architect, about his upcoming new job. He asked me about how I learn a new architecture. I walked him through the process that I use during a microservices consulting engagement to understand a client’s existing architecture.

This is the first of a series of posts that explain the steps of the process. These steps also correspond to sections of an architecture document. The other articles in the series are:

I’ll use the FTGO application from my Microservices Patterns book as an example. Here is the vision statement for this application:

FTGO is a food delivery application. Consumers use FTGO to place food orders at local restaurants. FTGO coordinates a network of couriers who deliver the orders. It also pays couriers and restaurants. Restaurants use the FTGO website to edit their menus and manage orders

Since an application exists to enable ‘users’ to accomplish their goals, I like to start on the outside by learning about (and documenting) the system context.

The system context

The system context is the black box model of the application. It consists of the following elements:

  1. the application
  2. the actors - humans and other applications that use the application - and their goals
  3. the responsibilities of the key external services/applications used by the application

The system context is documented using some combination of diagrams and text. It’s often useful to create a diagram that visualizes the system context model. For example, here is the system context diagram for the FTGO application:

See OMG are you still using Rational Rose? for an explanation of this diagram’s visual notation along with important architecture documentation concepts.

The documentation must also describe the goals of the actors and responsibilities the external services. For example, for the FTGO application, the key actors are:

  • Consumer - places orders at restaurants
  • Restaurant - manages the menu and prepares the food
  • Courier - delivers the order

The key external services/applications are:

  • Stripe - charging consumer credit cards
  • Twilio - sending text messages
  • Amazon Simple Email Service (SES) - sending emails

You might find it useful to incorporate this information into the diagram. Alternatively, you might skip the diagram entirely since it’s essentially a list of actors and services/application. You could, for example, present the information in a table.

What’s next

In the next article, I explain the next step: understanding/documenting key user stories and scenarios.

Need help adopting microservices?

I provide consulting and training.


application architecture   architecture documentation   architecting  


Copyright © 2024 Chris Richardson • All rights reserved • Supported by Kong.

About Microservices.io

Microservices.io is brought to you by Chris Richardson. Experienced software architect, author of POJOs in Action, the creator of the original CloudFoundry.com, and the author of Microservices patterns.

Chris helps organizations improve agility and competitiveness through better software architecture. Learn more about his consulting engagements, and training workshops.

Upcoming public talks/workshops

PREMIUM CONTENT

Premium content and office hours is now available for paid subscribers at premium.microservices.io.

MICROSERVICES WORKSHOPS

Chris teaches comprehensive workshops for architects and developers that will enable your organization use microservices effectively.

Avoid the pitfalls of adopting microservices and learn essential topics, such as service decomposition and design and how to refactor a monolith to microservices.

Learn more

LEARN about microservices

Chris offers numerous other resources for learning the microservice architecture.

Get the book: Microservices Patterns

Read Chris Richardson's book:

Example microservices applications

Want to see an example? Check out Chris Richardson's example applications. See code

Remote consulting session

Got a specific microservice architecture-related question? For example:

  • Wondering whether your organization should adopt microservices?
  • Want to know how to migrate your monolith to microservices?
  • Facing a tricky microservice architecture design problem?

Consider signing up for a two hour, highly focussed, consulting session.

Virtual bootcamp: Distributed data patterns in a microservice architecture

My virtual bootcamp, distributed data patterns in a microservice architecture, is now open for enrollment!

It covers the key distributed data management patterns including Saga, API Composition, and CQRS.

It consists of video lectures, code labs, and a weekly ask-me-anything video conference repeated in multiple timezones.

The regular price is $395/person but use coupon ILFJODYS to sign up for $95 (valid until March 12, 2024). There are deeper discounts for buying multiple seats.

Learn more

Learn how to create a service template and microservice chassis

Take a look at my Manning LiveProject that teaches you how to develop a service template and microservice chassis.

Signup for the newsletter


BUILD microservices

Ready to start using the microservice architecture?

Consulting services

Engage Chris to create a microservices adoption roadmap and help you define your microservice architecture,


The Eventuate platform

Use the Eventuate.io platform to tackle distributed data management challenges in your microservices architecture.

Eventuate is Chris's latest startup. It makes it easy to use the Saga pattern to manage transactions and the CQRS pattern to implement queries.

ASSESS your architecture

Assess your application's microservice architecture and identify what needs to be improved.

Consulting services

Engage Chris to conduct an architectural assessment.



Join the microservices google group

Topics

Note: tagging is work-in-process

GitOps   ·  Microservices adoption   ·  ancient lore   ·  anti-patterns   ·  application api   ·  application architecture   ·  architecting   ·  architecture   ·  architecture documentation   ·  assemblage   ·  beer   ·  books   ·  containers   ·  dark energy and dark matter   ·  deployment   ·  deployment pipeline   ·  design-time coupling   ·  developer experience   ·  development   ·  devops   ·  docker   ·  eventuate platform   ·  generative AI   ·  glossary   ·  health   ·  hexagonal architecture   ·  implementing commands   ·  implementing queries   ·  inter-service communication   ·  kubernetes   ·  loose coupling   ·  microservice architecture   ·  microservice chassis   ·  microservices adoption   ·  microservicesio updates   ·  modular monolith   ·  multi-architecture docker images   ·  observability   ·  pattern   ·  refactoring to microservices   ·  resilience   ·  sagas   ·  security   ·  service api   ·  service architecture   ·  service blueprint   ·  service collaboration   ·  service design   ·  service discovery   ·  service granularity   ·  service template   ·  software delivery metrics   ·  success triangle   ·  tacos   ·  team topologies   ·  testing   ·  transaction management   ·  transactional messaging

All content


Posts

24 Jul 2017 » Revised data patterns