Skip to content
This repository has been archived by the owner on Feb 7, 2024. It is now read-only.

Build TechDoc Structure (SysSpec vs. Arc42) #398

Closed
darenegade opened this issue Nov 11, 2022 · 3 comments
Closed

Build TechDoc Structure (SysSpec vs. Arc42) #398

darenegade opened this issue Nov 11, 2022 · 3 comments
Labels
refinement Ready to refine within core team

Comments

@darenegade
Copy link
Member

darenegade commented Nov 11, 2022

Take SysSpec, remove unnecessary chapters, compare result with arc24 and add missing chapters


Beide erscheinen für eine öffentliche Doku etwas überfrachtet und enthalten viele Kapitel, die eher intern ins Betriebshandbuch gehören. Daher hier ein Versuch der Reduktion:

  1. Einführung
  2. IT-Architektur
  3. Querschnittliche Konzepte
  4. Schnittstellen
  5. Entwurfsentscheidungen

Vielleicht starten wir erstmal eher mit weniger und nehmen Kapitel hinzu, wenn diese uns fehlen.

Das Ziel der TechDoku als UserStory formuliert: Als OpenSource Entwickler*in für die Plattform möchte ich das Gesamtsystem verstehen und Entscheidungen nachvollziehen können, sodass ich schnell einen Überblick bekomme aber auch tiefgreifende Konzepte nachvollziehen kann und damit mich an der Entwicklung der Plattform beteiligen kann.

@darenegade darenegade added the refinement Ready to refine within core team label Nov 14, 2022
@darenegade darenegade changed the title Build TechDoc Structure (SysSpec vs. Arc24) Build TechDoc Structure (SysSpec vs. Arc42) Nov 14, 2022
@darenegade
Copy link
Member Author

SysSpec

image.png
image.png

@darenegade
Copy link
Member Author

Arc24

image.png

@darenegade
Copy link
Member Author

Wir haben aktuell schon eine Struktur, die dem nahe kommt. Darauf bauen wir nun einfach auf:

image.png

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
refinement Ready to refine within core team
Projects
None yet
Development

No branches or pull requests

1 participant