Vorlage – Referenzseite

Interne Vorlage. Diese Vorlagenseite nicht öffentlich freigeben. Vor der Verwendung alle Platzhalter ersetzen, nicht benötigte Module vollständig entfernen und sämtliche internen Hinweise prüfen.

Vorlagenname	Referenzseite
Status	Verbindliche Arbeitsvorlage
Version	1.0
Gültig ab	23. August 2026
Einsatzbereich	referenz.hosenmatz.com
Zweck	Schnelles und präzises Nachschlagen konkreter technischer Informationen

Verwendung

1. Quellcode aus dem Bereich „Kopiervorlage“ kopieren.
2. Neue Seite im passenden Buch und Kapitel anlegen.
3. Quellcodeansicht öffnen und Code einfügen.
4. Referenzart festlegen.
5. Alle Pflichtangaben ausfüllen.
6. Nur die für diese Referenzart sinnvollen Module stehen lassen.
7. Nicht benötigte Module vollständig entfernen.
8. Vorhandene Glossar-, Lern-, Wissens- und Referenzseiten verlinken.
9. Geplante, noch nicht vorhandene Anschlussseiten mit „(geplant)“ kennzeichnen.
10. Passende BookStack-Tags setzen.
11. Syntax, Befehle, Werte, Versionen und Links fachlich prüfen.
12. Darstellung und Berechtigungen kontrollieren.

Grundregel: Eine Referenzseite ist zum Nachschlagen da. Sie soll konkrete Informationen möglichst schnell auffindbar machen.

Ausführliche didaktische Erklärungen gehören auf lernen.drachenbrut-larp.de. Fachliche Hintergründe und theoretische Vertiefungen gehören auf wissen.hosenmatz.com.

Abgrenzung der Wissensebenen

Glossar	Was bedeutet der Begriff?
Lernen	Wie kann ich das Thema verstehen und lernen?
Wissen	Was steckt fachlich genauer dahinter?
Referenz	Wie lautet die konkrete Syntax, Einstellung, Option, Notation, Tabelle oder Vorgehensweise?

Mögliche Referenzarten

Die Referenzart bestimmt, welche Module der Vorlage benötigt werden. Nicht jede Referenzseite verwendet alle Bereiche.

Referenzart	Typischer Inhalt
Befehl	Syntax, Optionen, Parameter, Beispiele, Rückgabe
Syntax	Schreibweise, Bestandteile, Regeln, Beispiele
Konfiguration	Datei, Schlüssel, Werte, Standardwerte, Auswirkungen
Parameter / Option	Name, Datentyp, erlaubte Werte, Bedeutung, Standardwert
Notation	Zeichen, Bedeutung, Schreibweise, Regeln
Tabelle / Nachschlagewert	Werte, Codes, Zustände, Bedeutungen
Ablauf / Vorgehensweise	Voraussetzungen, Schritte, Ergebnis, Kontrolle
Datei / Pfad / Struktur	Speicherort, Aufbau, Zweck, wichtige Dateien oder Verzeichnisse
Schnittstelle / API	Endpunkt, Methode, Parameter, Request, Response, Statuscodes
Sonstige technische Referenz	Andere klar strukturierte Nachschlageinformationen

Tags

Die Tags werden separat über die BookStack-Seiteneigenschaften gesetzt und nicht in den sichtbaren HTML-Inhalt geschrieben.

Mindestens vorgesehen:

Typ: Referenz
Thema: [Themengebiet]
Referenzart: [Referenzart]

Beispiele:

Typ: Referenz
Thema: Git
Referenzart: Befehl

Typ: Referenz
Thema: PHP
Referenzart: Konfiguration

Mehrere Themen-Tags dürfen gesetzt werden, wenn eine Seite tatsächlich mehreren Themengebieten zugeordnet ist.

Kopiervorlage

<!--
BookStack-Struktur
------------------
Buch: [BUCH]
Kapitel: [KAPITEL]
Seite: [SEITENTITEL]

Referenzart: [REFERENZART]

Der Seitentitel wird in BookStack separat vergeben.
Deshalb enthält dieser Quellcode kein H1.
-->


<p>
[Kurze Beschreibung:
Was kann auf dieser Seite konkret nachgeschlagen werden?
In ein bis drei Sätzen erklären.]
</p>


<table>
<tbody>

<tr>
    <th>Referenzart</th>
    <td>[Befehl / Syntax / Konfiguration / Parameter / Notation / Tabelle / Ablauf / API / ...]</td>
</tr>

<tr>
    <th>Thema</th>
    <td>[z. B. Git, PHP, Apache, Docker, BookStack]</td>
</tr>

<tr>
    <th>Gültig für</th>
    <td>[Version, System, Plattform oder Umgebung, sofern relevant]</td>
</tr>

<tr>
    <th>Voraussetzungen</th>
    <td>[notwendige Voraussetzungen oder „keine besonderen“]</td>
</tr>

</tbody>
</table>


<p class="callout info">
[OPTIONAL – ERSETZEN ODER ENTFERNEN:

Kurzer wichtiger Hinweis,
der vor Verwendung der Referenz bekannt sein sollte.

Wird keine solche Information benötigt,
diese Box vollständig entfernen.]
</p>


<h2>Kurzreferenz</h2>

<p>
[Die wichtigste konkrete Information direkt und ohne lange Einleitung angeben.

Beispiele:
- vollständiger Befehl,
- wichtigste Syntax,
- Konfigurationswert,
- Dateipfad,
- Notation,
- entscheidender Tabellenwert.]
</p>


<h2>Syntax / Schreibweise</h2>

<p>
[OPTIONAL – ERSETZEN ODER ENTFERNEN:

Verwende diesen Abschnitt für:
- Befehle,
- Funktionen,
- Methoden,
- Notationen,
- Konfigurationssyntax,
- API-Aufrufe
oder ähnliche strukturierte Schreibweisen.

Wird keine Syntax benötigt,
diesen Abschnitt vollständig entfernen.]
</p>

<pre><code>[SYNTAX ODER BEFEHL]</code></pre>


<h2>Parameter und Optionen</h2>

<p>
[OPTIONAL – ERSETZEN ODER ENTFERNEN:

Verwende diesen Abschnitt,
wenn Parameter, Optionen, Argumente oder Flags vorhanden sind.

Wird dieser Abschnitt nicht benötigt,
vollständig entfernen.]
</p>

<table>
<thead>
<tr>
    <th>Parameter / Option</th>
    <th>Bedeutung</th>
    <th>Wert / Typ</th>
    <th>Standard</th>
</tr>
</thead>

<tbody>

<tr>
    <td>[Parameter]</td>
    <td>[Bedeutung]</td>
    <td>[Wert oder Datentyp]</td>
    <td>[Standardwert]</td>
</tr>

</tbody>
</table>


<h2>Werte und mögliche Einstellungen</h2>

<p>
[OPTIONAL – ERSETZEN ODER ENTFERNEN:

Verwende diesen Abschnitt für:
- erlaubte Werte,
- Konfigurationswerte,
- Zustände,
- Codes,
- Konstanten
oder andere feste Auswahlmöglichkeiten.

Wird dieser Abschnitt nicht benötigt,
vollständig entfernen.]
</p>

<table>
<thead>
<tr>
    <th>Wert</th>
    <th>Bedeutung</th>
</tr>
</thead>

<tbody>

<tr>
    <td>[Wert]</td>
    <td>[Bedeutung]</td>
</tr>

</tbody>
</table>


<h2>Rückgabe / Ergebnis</h2>

<p>
[OPTIONAL – ERSETZEN ODER ENTFERNEN:

Beschreibe:
- Rückgabewerte,
- erzeugte Dateien,
- veränderte Zustände,
- Ausgaben,
- Statuscodes,
- sichtbare Ergebnisse.

Wird dieser Abschnitt nicht benötigt,
vollständig entfernen.]
</p>


<h2>Beispiele</h2>

<p>
[OPTIONAL – ERSETZEN ODER ENTFERNEN:

Zeige kurze,
konkrete und direkt nutzbare Beispiele.

Referenzbeispiele sollen knapp bleiben.
Ausführliche Lernbeispiele gehören auf lernen.drachenbrut-larp.de.

Wird dieser Abschnitt nicht benötigt,
vollständig entfernen.]
</p>

<h3>Beispiel 1</h3>

<pre><code>[BEISPIEL]</code></pre>

<p>
[Kurze Erklärung des Ergebnisses.]
</p>


<h2>Konfiguration</h2>

<p>
[OPTIONAL – ERSETZEN ODER ENTFERNEN:

Verwende diesen Abschnitt,
wenn eine Datei,
eine Einstellung
oder ein Konfigurationsblock beschrieben wird.

Wird dieser Abschnitt nicht benötigt,
vollständig entfernen.]
</p>

<table>
<tbody>

<tr>
    <th>Datei / Ort</th>
    <td>[Pfad oder Speicherort]</td>
</tr>

<tr>
    <th>Schlüssel</th>
    <td>[Konfigurationsschlüssel]</td>
</tr>

<tr>
    <th>Standardwert</th>
    <td>[Standard]</td>
</tr>

</tbody>
</table>

<pre><code>[KONFIGURATIONSBEISPIEL]</code></pre>


<h2>Ablauf / Vorgehensweise</h2>

<p>
[OPTIONAL – ERSETZEN ODER ENTFERNEN:

Verwende diesen Abschnitt,
wenn eine konkrete technische Vorgehensweise
oder ein standardisierter Ablauf nachgeschlagen werden soll.

Wird dieser Abschnitt nicht benötigt,
vollständig entfernen.]
</p>

<ol>
    <li>[Schritt 1]</li>
    <li>[Schritt 2]</li>
    <li>[Schritt 3]</li>
</ol>


<h2>Prüfung / Kontrolle</h2>

<p>
[OPTIONAL – ERSETZEN ODER ENTFERNEN:

Beschreibe,
wie geprüft werden kann,
ob der Befehl,
die Konfiguration
oder der Ablauf erfolgreich war.

Beispiele:
- erwartete Ausgabe,
- Prüfkommando,
- Status,
- Test,
- sichtbares Ergebnis.

Wird dieser Abschnitt nicht benötigt,
vollständig entfernen.]
</p>


<h2>Hinweise und Besonderheiten</h2>

<p>
[OPTIONAL – ERSETZEN ODER ENTFERNEN:

Dokumentiere Besonderheiten,
Abhängigkeiten,
Versionsunterschiede,
Plattformunterschiede
oder andere wichtige technische Hinweise.

Wird dieser Abschnitt nicht benötigt,
vollständig entfernen.]
</p>


<p class="callout success">
[OPTIONAL – TIPP:

Praktischer Hinweis,
Abkürzung
oder sinnvolle Vorgehensweise.

Wird diese Box nicht benötigt,
vollständig entfernen.]
</p>


<h2>Typische Fehler</h2>

<p>
[OPTIONAL – ERSETZEN ODER ENTFERNEN:

Beschreibe typische Fehlermeldungen,
Fehlkonfigurationen,
falsche Parameter
oder häufige Missverständnisse.

Wird dieser Abschnitt nicht benötigt,
vollständig entfernen.]
</p>


<p class="callout danger">
[OPTIONAL – ACHTUNG:

Kritischer Fehler,
gefährliche Option,
wichtige Einschränkung
oder besonders relevante Stolperfalle.

Wird diese Box nicht benötigt,
vollständig entfernen.]
</p>


<hr>


<h2>Verknüpfungen</h2>


<h3>Lernen</h3>

<p>
[OPTIONAL – ERSETZEN ODER ENTFERNEN:

Verlinke eine passende Einsteigerseite
auf lernen.drachenbrut-larp.de.

Existiert sie bereits:
direkt verlinken.

Ist sie geplant:
unverlinkt mit „(geplant)“ aufführen.

Ist keine Lernseite sinnvoll,
diesen Abschnitt vollständig entfernen.]
</p>


<h3>Wissen</h3>

<p>
[OPTIONAL – ERSETZEN ODER ENTFERNEN:

Verlinke eine passende fachliche Vertiefung
auf wissen.hosenmatz.com.

Existiert sie bereits:
direkt verlinken.

Ist sie geplant:
unverlinkt mit „(geplant)“ aufführen.

Ist keine Wissensseite sinnvoll,
diesen Abschnitt vollständig entfernen.]
</p>


<h3>Begriff im Glossar</h3>

<p>
[OPTIONAL – ERSETZEN ODER ENTFERNEN:

Verlinke den passenden Glossareintrag.

Existiert er bereits:
direkt verlinken.

Ist er geplant:
unverlinkt mit „(geplant)“ aufführen.

Ist kein Glossareintrag sinnvoll,
diesen Abschnitt vollständig entfernen.]
</p>


<h3>Verwandte Referenzen</h3>

<p>
[OPTIONAL – ERSETZEN ODER ENTFERNEN:

Verlinke weitere passende Seiten
auf referenz.hosenmatz.com.

Bereits vorhandene Referenzen direkt verlinken.
Geplante Referenzen unverlinkt mit „(geplant)“ aufführen.

Wird dieser Abschnitt nicht benötigt,
vollständig entfernen.]
</p>

<ul>
    <li>[Vorhandene Referenz]</li>
    <li>[Geplante Referenz] <em>(geplant)</em></li>
</ul>


<hr>


<h2>Quellen und offizielle Dokumentation</h2>

<p>
[Verlinke die technische Grundlage der Angaben.

Bevorzugt:
- offizielle Dokumentation,
- Herstellerdokumentation,
- Standard oder Norm,
- Projektdokumentation,
- oder vorhandene zentrale Quellenübersicht.

Bei versionsabhängigen Informationen
muss möglichst die passende Dokumentationsversion verwendet werden.]
</p>


<p>
<small>
Technisch geprüft: [Datum]<br>
Gültig für: [Version / Umgebung]
</small>
</p>

Regel für geplante Verknüpfungen

Geplante Anschlussseiten werden nicht vollständig entfernt. Damit spätere Verlinkungen nicht vergessen werden, dürfen noch nicht vorhandene Seiten unverlinkt mit „(geplant)“ aufgeführt werden.

Beispiel:

git restore – Referenz (geplant)

Sobald die Zielseite veröffentlicht wurde, wird der Eintrag verlinkt und der Zusatz „(geplant)“ entfernt.

Redaktionelle Abschlussprüfung

• Ist sofort erkennbar, was auf dieser Seite nachgeschlagen werden kann?
• Ist die Referenzart korrekt festgelegt?
• Sind nur tatsächlich benötigte Module enthalten?
• Ist die wichtigste Information schnell auffindbar?
• Ist Syntax exakt geschrieben?
• Sind Parameter, Optionen und Werte vollständig und korrekt?
• Sind Standardwerte korrekt angegeben?
• Sind Versions- oder Plattformabhängigkeiten dokumentiert?
• Sind Beispiele kurz und technisch korrekt?
• Wurden lange didaktische Erklärungen vermieden?
• Wurden fachliche Vertiefungen nicht unnötig dupliziert?
• Sind typische Fehler oder kritische Hinweise dokumentiert, sofern relevant?
• Sind vorhandene Lernseiten korrekt verlinkt?
• Sind vorhandene Wissensseiten korrekt verlinkt?
• Sind vorhandene Glossarseiten korrekt verlinkt?
• Sind verwandte Referenzen korrekt verlinkt?
• Sind geplante Anschlussseiten mit „(geplant)“ gekennzeichnet?
• Ist eine offizielle oder fachlich geeignete Quelle angegeben?
• Ist der technische Prüfstand dokumentiert?
• Sind alle Platzhalter und internen Bearbeitungshinweise entfernt?
• Sind passende BookStack-Tags gesetzt?
• Wurde die Sichtbarkeit beziehungsweise Berechtigung geprüft?