Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Save more on your purchases! discount-offer-chevron-icon
Savings automatically calculated. No voucher code required.
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Free Learning
Arrow right icon
Arrow up icon
GO TO TOP
arc42 by Example

You're reading from   arc42 by Example Software architecture documentation in practice

Arrow left icon
Product type Paperback
Published in Oct 2019
Publisher
ISBN-13 9781839214356
Length 236 pages
Edition 1st Edition
Arrow right icon
Authors (4):
Arrow left icon
Michael Simons Michael Simons
Author Profile Icon Michael Simons
Michael Simons
Ralf D. Müller Ralf D. Müller
Author Profile Icon Ralf D. Müller
Ralf D. Müller
Stefan Zörner Stefan Zörner
Author Profile Icon Stefan Zörner
Stefan Zörner
Gernot Starke Gernot Starke
Author Profile Icon Gernot Starke
Gernot Starke
Arrow right icon
View More author details
Toc

Table of Contents (9) Chapters Close

About the Book Acknowledgements
I - Introduction FREE CHAPTER II - HTML Sanity Checking III - Mass Market Customer Relationship Management IV - biking2 V - DokChess VI - docToolchain VII - macOS Menu Bar Application

VII - macOS Menu Bar Application

This surely is one of the shortest and most compact architecture documentations.

Its goal is to show that arc42 can be tailored to suit your needs and be reduced to keep only a minimal amount of documentation.

I implemented this example as a brief excursion into the Swift programming language. I did not want to invest too much time on the documentation, although I wanted to highlight the most important facts about this implementation.

The result: a few keywords on requirements, the names of some important OS classes, and a few links to resources that I found useful during implementation.

I used a mindmap instead of text, tables, and diagrams:

Figure 7.1: Extremely short documentation
lock icon The rest of the chapter is locked
arrow left Previous Section
Register for a free Packt account to unlock a world of extra content!
A free Packt account unlocks extra newsletters, articles, discounted offers, and much more. Start advancing your knowledge today.
Unlock this book and the full library FREE for 7 days
Get unlimited access to 7000+ expert-authored eBooks and videos courses covering every tech area you can think of
Renews at $19.99/month. Cancel anytime
Banner background image