Documentation / Developer

Documentation Developer

Der Developer-Bereich beschreibt gemeinsame Grundlagen für Generatoren, Assets, Daten, Audits und Veröffentlichungen.

ACTIVE DOCUMENTATION AREA

Erweiterbare Dokumentationsplattform

Neue Dokumentationsbereiche sollten gemeinsame Assets, Datenstrukturen, Navigationsmodelle und Prüfverfahren wiederverwenden.

Documentation Components

Kernbereiche

DOCUMENTATION

Shared Assets

Gemeinsames CSS und JavaScript für konsistente Dokumentationsseiten.

DOCUMENTATION

Structured Data

JSON-Dateien für Bereiche, Ressourcen und Architektur.

DOCUMENTATION

Page Generator

Deterministische Erzeugung vollständiger Unterseiten.

DOCUMENTATION

Local Audit

Prüfung von Seiten, Daten, Links, Routen und Assets.

DOCUMENTATION

Production Build

Verbindung von Git-, HTML-, JSON- und Site-Prüfungen.

DOCUMENTATION

Live Audit

Kontrolle der veröffentlichten Documentation-Routen.

PRINCIPLES

Dokumentationsgrundsätze

  • Gemeinsame Assets wiederverwenden
  • Neue Bereiche strukturiert definieren
  • PowerShell-Syntax vor Ausführung prüfen
  • Lokale Audits vor dem Commit durchführen
  • Production-Build und Live-Audit abschließen
STRUCTURED DATA

Datenquelle

Dieser Bereich verwendet gemeinsame, lokal validierte Documentation-Daten.

sections.json öffnen

AUDIT

Qualitätssicherung

Dokumentationsseiten, JSON-Dateien, interne Links, Routen und Asset-Verweise werden vor der Veröffentlichung geprüft.

DOCUMENTATION

Weitere Dokumentationsbereiche