Skip to content

Instantly share code, notes, and snippets.

@paulwellnerbou

paulwellnerbou/arch-de.asciidoc

Last active October 11, 2015 09:25
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save paulwellnerbou/9000d45bd0066367a09e to your computer and use it in GitHub Desktop.
Save paulwellnerbou/9000d45bd0066367a09e to your computer and use it in GitHub Desktop.
Download ZIP
Deutsche Vorlage für Simon Browns Architekturdokumentationsvorschlag
Raw
arch-de.asciidoc

Architekturdokumentation

Kontext

Fachlicher Kontext

Um was geht es, fachlich gesehen?

Aufgabenstellung

Was macht das System?

Qualitätsziele

Existieren relevante nicht-funktionale Anforderungen?

Performance

Sicherheit

Randbedingungen

Existieren relevante Randbedingungen?

Implementierung und Architektur

Lösungsstrategie

Welche Design- und Entwicklungsprinzipien wurden angewendet? Interne Schnittstellen?

Architektur-Überblick

Table 1. Komponenten

Komponente

Aufgabe

Externe Schnittstellen

→ Schnittstellenbeschreibung

Quellen und Entwicklungsumgebung

→ Entwicklungshandbuch bzw. README.md

Daten und Persistenz

Gibt es (permanent oder temporär) gespeicherte Daten? Wo und wie werden diese Daten gespeichert? Transaktionen? Backup? Replikation?

Betrieb

Infrastructure Architecture

Deployment-Sicht: Welche Deployment-Artefakte gibt es?

Deployment

Tatsächliches Deployment-Szenario, ggf. mit mehreren Nodes/Replikation

Betriebshandbuch

→ Betriebshandbuch

Entscheidungs-Log

Table 2. Entscheidungs-Log

Entscheidung

Begründung

Getroffen von

Datum
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment