Simple arc42 template which can be used for documenting your systems's architecture with arc42 and GitBook.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_book
node_modules
01-introduction-and-goals.md
02-architecture-constraints.md
03-system-scope-and-context.md
04-solution-strategy.md
05-building-block-view.md
06-runtime-view.md
07-deployment-view.md
08-concepts.md
09-design-decisions.md
10-quality-scenarios.md
11-technical-risks.md
GLOSSARY.md
README.md
SUMMARY.md
book.json
template-blackbox-long.md
template-blackbox-short.md
template-whitebox.md

README.md

Arc 42 template for GitBook

Why is this template here?

First: Because I wanted to learn GitBook and therefore I needed an example topic.

Second: Until now I could only find an arc42 template for Asciidoc. Of course you can use Asciidoc in combination with GitBook but I wanted to use the markdown version ;-).

If you have/know a better template for arc42 using GitBook then just let me know.

The current content language is German.

What can I use it for?

This is just a set of markdown files to have an easy start with documenting your systems's architecture using arc42 and GitBook.

How do I use it?

  • Install nodejs+npm

  • Install GitBook

    $ npm install gitbook-cli -g
    $ gitbook update
    
  • Clone this git repo

    $ git clone https://github.com/nrekretep/arc42-gitbook-template.git
    $ mv arc42-gitbook-template/ my-arc-doc/
    $ cd my-arc-doc
    $ rm -rf .git
    

What should I do next?

  • Read everything about Arc 42
  • Download the GitBook Editor
  • Start documenting your system
  • Build your documentation as a set of html files
$ gitbook build
$ gitbook serve