Zum Hauptinhalt springen

Documentation Guidelines

In Bearbeitung

Diese Dokumentation wird derzeit erstellt.

Übersicht​

Richtlinien für das Schreiben und Pflegen der Developer-Dokumentation.

Dokumentations-Struktur​

Die Developer-Dokumentation folgt diesen Prinzipien:

  • Technischer Fokus - Nur für Entwickler relevante Inhalte
  • Getrennt vom User Handbook - Keine Vermischung mit Endbenutzer-Dokumentation
  • Markdown-basiert - Einfach zu pflegen und versioniert

Best Practices​

Schreibstil​

  • Kurz und präzise
  • Code-Beispiele wo sinnvoll
  • Links zu verwandten Themen

Struktur​

  • Klare Überschriften-Hierarchie
  • Verwendung von Admonitions (:::info, :::warning)
  • Sidebar-Position für Navigation

Mehr Details folgen in Kürze.