Sign In Start Free Trial
Account

Add to playlist

Create a Playlist

Modal Close icon
You need to login to use this feature.
  • Book Overview & Buying arc42 by Example
  • Table Of Contents Toc
arc42 by Example

arc42 by Example

By : Gernot Starke, Michael Simons, Stefan Zörner, Ralf D. Müller
close
close
arc42 by Example

arc42 by Example

By: Gernot Starke, Michael Simons, Stefan Zörner, Ralf D. Müller

Overview of this book

When developers document the architecture of their systems, they often invent their own specific ways of articulating structures, designs, concepts, and decisions. What they need is a template that enables simple and efficient software architecture documentation. arc42 by Example shows how it's done through several real-world examples. Each example in the book, whether it is a chess engine, a huge CRM system, or a cool web system, starts with a brief description of the problem domain and the quality requirements. Then, you'll discover the system context with all the external interfaces. You'll dive into an overview of the solution strategy to implement the building blocks and runtime scenarios. The later chapters also explain various cross-cutting concerns and how they affect other aspects of a program.
Table of Contents (9 chapters)
close
close
Lock Free Chapter
1
Acknowledgements
8
VII - macOS Menu Bar Application

VI.7 Deployment View

docToolchain is only used to generate documentation and is, therefore, not deployed to a production environment. However, depending on your requirements, you might want to deploy it not only to your development machine but also to a build server.

The general deployment is done by cloning the docToolchain source repository. Depending on your needs, the details will vary.

7.1 Option 1: Installed the Command-Line Tool

For this option, you clone the docToolchain repository to a location outside of the project you want to write the documentation for. You then add the <docToolchain home>/bin folder to your PATH variable. Now you can use docToolchain as a command-line tool:

doctoolchain <docDir> <task>

This approach works quite well and is independent of your project. However, it violates RQ6 (clone, build, test, and run) for your project. Someone who clones your project will also have to install docToolchain before they can work on the documentation. Also, making...

CONTINUE READING
83
Tech Concepts
36
Programming languages
73
Tech Tools
Icon Unlimited access to the largest independent learning library in tech of over 8,000 expert-authored tech books and videos.
Icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Icon 50+ new titles added per month and exclusive early access to books as they are being written.
arc42 by Example
notes
bookmark Notes and Bookmarks search Search in title playlist Add to playlist font-size Font size

Change the font size

margin-width Margin width

Change margin width

day-mode Day/Sepia/Night Modes

Change background colour

Close icon Search
Country selected

Close icon Your notes and bookmarks

Confirmation

Modal Close icon
claim successful

Buy this book with your credits?

Modal Close icon
Are you sure you want to buy this book with one of your credits?
Close
YES, BUY

Submit Your Feedback

Modal Close icon
Modal Close icon
Modal Close icon