logo hsb.horse

Architecture Decision Record

Einführungsrichtlinie für die Snippets-Collection für leichte Praxisnotizen

Praktische Notizen, die zu kurz für Blogartikel sind, in snippets auslagern und unter /snippets sowie /{lang}/snippets als Liste/Detail bereitstellen.

Angenommen #content #snippets #blog #information-architecture #seo

Einführungsrichtlinie für die Snippets-Collection für leichte Praxisnotizen

Decision

  • Kurze Praxisnotizen (Command-Fragmente, minimale Abläufe, kurze Konfigurationsbeispiele) werden in snippets abgelegt.
  • Das Inhaltsmodell nutzt drei Typen: chronologische Beiträge in blog, Wissens-/Definitionsseiten in glossary, praktische Fragmente in snippets.
  • Die Collection snippets wird ergänzt und als Liste/Detail unter /snippets und /{lang}/snippets bereitgestellt.
  • _template.ja.md bleibt bestehen; Dateien mit _-Präfix werden von der Veröffentlichung ausgeschlossen.

Context

Für kurze Praxisnotizen gab es bisher keinen klaren Ablageort:

  • Zu kurz für einen Blogbeitrag
  • Keine Definitionsseite für das Glossar

Werden solche Inhalte in blog gemischt, verwischt die Seiten- und Suchintention.
glossary ist definitionsorientiert und passt nicht gut zu command-zentrierten Snippets.

Options

  • Option A: Kurze Praxisnotizen in blog belassen.
  • Option B: Unter glossary einsortieren.
  • Option C: Eigene Collection snippets einführen (gewählt).

Rationale

  • Leser erhalten klare Einstiegspunkte: Beiträge, Wissen und praktische Snippets.
  • Durch die Trennung bleibt der Qualitätsmaßstab für blog-Artikel stabil.
  • Getrennte URLs machen die Seitenintention für Suchmaschinen klarer.

Consequences

  • snippets-Collection-Schema in src/content.config.ts ergänzen.
  • src/features/snippets/*, src/pages/snippets/* und src/pages/[lang]/snippets* hinzufügen.
  • snippets-Bezeichnungen in Header-Navigation und i18n-Wörterbüchern ergänzen.
  • Ersten Inhalt (Batch-Konvertierungsnotiz mit avifenc) nach content/snippets/ migrieren.