• Stars
    star
    1,012
  • Rank 45,431 (Top 0.9 %)
  • Language
  • License
    Other
  • Created almost 11 years ago
  • Updated 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

arc42 - the template for software architecture documentation and communication

arc42 Template ("Golden Master")

https://vshymanskyy.github.io/StandWithUkraine

arc42 - the template for effective, practical and pragmatic software architecture documentation and communication.

Initially created by Dr. Gernot Starke and Dr. Peter Hruschka (way back in 2005…​), free and open source.

This repository contains all downloadable versions plus the (AsciiDoc) source of the arc42 template.

It is used…​

  • as the basis for generating (by the arc42-generator project) the official download formats (i.e. docx, markdown, docbook and others). To generate, THIS repo is included as submodule from the generator project. Use the gradle build contained here just for preview!

  • to maintain structure, content and help for the template

  • to keep non-asciidoc, non-generable formats (like Sparx® Enterprise-Architect® EAP).

In case you find issues within the template or its explanations, this is the repo to fix and issue pull requests :-)

Revisions

  • 8.2: Jan 28th 2023: Thx to A. Bentele, added imagedir def to all files, for easier editing asciidoc. See #178

Diagrams

We intend to provide all diagrams in platform-neutral formats, mainly drawio.

The source of these diagrams is embedded in a .png file. To make this explicit, we use the combined extension .drawio.png for our diagrams. The drawio tools will recognize this and open such files in the editor instead of an image viewer.

Therefore we will gradually remove all files under ./graphics-originals

Downloads

Please refer to the official download page for all downloads.

Languages

The EN and DE versions are actively maintained by the founders (G.Starke & P.Hruschka). Translations to additional languages (see below) have been provided by volunteers, but won’t be automatically updated.

Build the HTML version

In case you want to build the HTML version of the template, just checkout this repo and call

$> gradle asciidoctor

on the command line. To select another language set the Gradle build property LANGUAGE to one of the provided languages, cf.

link:gradle.properties[]

Currently (March 2022) you need to use Java 8 to build!

Questions on using arc42?

Suggestions welcome

Open an issue here!

More Repositories

1

quality-requirements

Beispiele für Qualitätsanforderungen an Software (etwa: Zur Vereinfachung von ATAM-Analysen oder Quality-Driven Software Architecture)
Shell
79
star
2

HHGDAC

Hitchhikers Guide to Docs-as-Code - Code + Infos zur JavaMagazin-Kolumne von R.D. Müller und G.Starke
JavaScript
55
star
3

arc42-generator

a gradle build to generate all derived templates from arc42-master
Groovy
45
star
4

docs.arc42.org-site

Help, documentation and tips on using arc42: arc42 online manual (content and jekyll theme)
JavaScript
38
star
5

microservice-examples

a (somewhat curated) collection of microservice examples.
25
star
6

canvas.arc42.org-site

Software Architecture Canvas
SCSS
22
star
7

quality.arc42.org-site

Quality requirements and goals for software and system architectures
JavaScript
22
star
8

patterns.arc42.org-site

A brief overview of architecture and design patterns
SCSS
20
star
9

arc42-process

Activities of software architects - explained and mapped to the arc42-template
Shell
11
star
10

arc42.org-site

(jekyll-based) website for arc42.org - the template for communicating software architectures.
SCSS
6
star
11

faq.arc42.org-site

Website for arc42-faq, companion to docs.arc42.org-site
CSS
3
star
12

arc42.de-site

Die deutsche arc42 Website. Ãœber Netlify gebaut, siehe https://arc42.de
SCSS
2
star
13

subtle-ads

Contains the common code for subtle advertisements that's included in several of the arc42 websites
Shell
2
star
14

arc42-faq

public & free FAQ for arc42, rendered at LeanPub, complements the book "arc42-in-Practice"
1
star
15

status.arc42.org-site

the statistics and status overview for all arc42 domains and ubdomains.
Go
1
star