.. _doku-contribute:

#####################################
Mitmachen - So trägst du bei
#####################################

Die Dokumentation lebt von deinen Beiträgen!
============================================

Wir sind eine Gemeinschaft. **Du brauchst kein IT-Experte zu sein, um mitzumachen!**

.. important::

   **Dein Wissen ist wertvoll!**

   Egal ob du seit Jahren dabei bist oder gerade erst anfängst -
   deine Perspektive und deine Erfahrungen helfen der ganzen Mannschaft.


Was kannst du beitragen?
========================

**Neue Inhalte**
   - Einsatzberichte und Best Practices
   - Ausbildungsunterlagen und Übungskonzepte
   - Tipps und Tricks aus der Praxis

**Verbesserungen**
   - Unklare Formulierungen korrigieren
   - Fehlende Informationen ergänzen
   - Alte Inhalte aktualisieren

**Fehler melden**
   - Tippfehler
   - Veraltete oder falsche Informationen
   - Defekte Links

**Ideen & Feedback**
   - Neue Themenwünsche
   - Strukturverbesserungen
   - Allgemeines Feedback


Dein Weg - Je nach Erfahrung
============================

**Du hast eine Idee, weißt aber nicht wo anfangen?**

Das ist völlig normal. Wir haben Wege für jeden:


Option 1: Der einfache Weg (für alle)
-------------------------------------

Du brauchst nur eine E-Mail zu schreiben:

1. **Schreib deine Idee auf** - egal wie
   - Handschriftliche Notizen? Gerne!
   - Word/PDF? Perfekt!
   - Fotos/Scans? Sehr hilfreich!
   - Einfach deine Gedanken per E-Mail? Klasse!

2. **Schreib das Doku-Team an**

   📧 **doku-team@feuerwehr-aidlingen.de**

   Schreib einfach: "Ich hätte eine Idee für..." oder "Ich habe einen Fehler gefunden..."

3. **Das Doku-Team kümmert sich um den Rest**

   Wir werden dich kontaktieren, geben dir Feedback und veröffentlichen deinen Beitrag.


Option 2: Der direkte Weg (mit Grundkenntnissen)
-------------------------------------------------

Du möchtest selbst schreiben, kennst dich aber mit Git nicht aus?

**Markdown - einfach und schnell**

Mit Markdown kannst du professionelle Texte schreiben - ohne komplizierte Formatierung:

.. code-block:: markdown

   # Überschrift
   ## Unterüberschrift

   **Fetter Text** und *kursiver Text*

   - Punkt 1
   - Punkt 2
   - Punkt 3

   1. Schritt 1
   2. Schritt 2

   [Link](https://example.com)
   ![Bild](pfad/zum/bild.jpg)

.. tip::

   **So fängst du an**:

   1. Öffne einen Texteditor (VS Code, Notepad++, etc.)
   2. Schreib deinen Beitrag
   3. Speichere als `mein-artikel.md`
   4. Schreib eine E-Mail und hänge die Datei an!

**Bilder vorbereiten**

- Gute Beleuchtung
- Relevante Details erkennbar
- Keine Personendaten in Bildern
- Quer-Format bevorzugt


Option 3: Der technische Weg (mit Git-Kenntnissen)
---------------------------------------------------

Du kennst dich mit Git aus und möchtest direkt in der Dokumentation arbeiten?

.. code-block:: bash

   # Repository klonen
   git clone https://gitlab.com/feuerwehr-aidlingen/dokumentation.git
   cd dokumentation

   # Feature Branch erstellen
   git checkout -b feature/dein-beitrag

   # Umgebung vorbereiten
   poetry install

   # Live-Vorschau starten
   poetry run sphinx-autobuild . build/

   # Deine Änderungen...
   git add .
   git commit -m "Beschreibung"
   git push origin feature/dein-beitrag

   # Merge Request auf GitLab erstellen


Was macht einen guten Beitrag aus?
===================================

**Inhalt**

.. list-table::
   :header-rows: 1
   :widths: 40 40

   * - ✅ So ist es gut
     - ❌ So weniger
   * - Konkrete, praktische Beispiele
     - Nur theoretische Beschreibungen
   * - Verständlich geschrieben
     - Zu viel Fachjargon
   * - Mit Überschriften strukturiert
     - Langer Fließtext
   * - Mit Bildern/Diagrammen
     - Nur Text
   * - Mit Quellenangabe
     - Herkunft unklar
   * - Mit aktuellem Datum
     - Alte Infos ohne Zeitangabe


**Struktur**

Folg diesem Muster:

.. code-block:: markdown

   # Aussagekräftiger Titel

   Kurze Zusammenfassung (2-3 Sätze)

   ## Warum ist das wichtig?

   Hintergrund erklären

   ## Das Wichtigste

   Die eigentlichen Infos

   ## Praktische Anwendung

   Wie nutzt man das?

   ## Weiterführende Infos

   Links zu verwandten Themen


**Schreibstil**

- **Kurze Sätze**: Auch unter Stress verständlich
- **Aktive Sprache**: "Öffne..." statt "Es wird geöffnet..."
- **Konkrete Beispiele**: "Bei Zimmerbränden..." statt "In Einsätzen..."
- **Visuelle Struktur**: Bilder, Listen, Tabellen


Checkliste vor dem Abschicken
==============================

.. list-table::
   :widths: 5 95

   * - ☑
     - Rechtschreibung geprüft
   * - ☑
     - Sinnvolle Überschriften
   * - ☑
     - Nicht zu lange Absätze
   * - ☑
     - Bilder mit Beschreibung
   * - ☑
     - Links funktioniertionieren
   * - ☑
     - Fachbegriffe erklärt
   * - ☑
     - Datum/Version angegeben
   * - ☑
     - Quellen genannt (falls relevant)


Vorlagen für häufige Inhalte
=============================

**Fahrzeugdokumentation**

Verwende die Vorlage: `_templates/fahrzeug_template.rst`

Beispielstruktur:

- Fahrzeugname & Funkrufname
- Übersicht (Baujahr, Hersteller, Besatzung)
- Beladung nach Geräteräumen
- Bedienung (Start, Fahrt, Einsatz)
- Wartung & Sicherheit


**Standard Operating Procedure (SOP)**

Verwende die Vorlage: `_templates/sop_template.rst`

Beispielstruktur:

- Zweck der SOP
- Anwendungsbereich
- Detaillierte Ablaufsschritte
- Sicherheitshinweise
- Kontaktpersonen


**Ausbildungsunterlage**

Beispielstruktur:

- Lernziele (was lernt man?)
- Dauer
- Theorie & Grundlagen
- Praktische Übungen
- Zusammenfassung


Häufige Fragen
==============

**Ich habe wenig Zeit für Formatierung**
   Kein Problem! Schreib uns den rohen Inhalt - wir formatieren das.

**Ich bin mir nicht sicher, ob mein Beitrag gut genug ist**
   Jeder Beitrag ist wertvoll! Lass uns gemeinsam daran arbeiten.

**Was passiert, wenn ich einen Fehler mache?**
   Alle Änderungen werden geprüft, bevor sie live gehen. Fehler finden wir vorher.

**Wie lange dauert es, bis mein Beitrag online ist?**
   Je nach Umfang 1-7 Tage. Dringende Inhalte gehen schneller.

**Kann ich einen Beitrag später noch ändern oder löschen?**
   Ja! Sprich einfach das Doku-Team an.

**Bekomme ich Rückmeldung?**
   Ja, wir informieren dich über jeden Schritt. Du kannst auch nachbessern.

**Soll ich meinen Namen unter den Beitrag setzen?**
   Das ist deine Entscheidung! Wir können auch anonyme Beiträge veröffentlichen.

**Ich habe technische Probleme**
   Das Doku-Team hilft bei allem - keine blöde Frage!


Deine Beiträge werden wertgeschätzt
====================================

- **Sichtbarkeit**: Dein Name wird genannt (auf Wunsch)
- **Statistiken**: Sieh, wie oft dein Beitrag gelesen wird
- **Feedback**: Erhalte Rückmeldungen der Leser
- **Top-Contributors**: Besonders aktive Autoren werden gewürdigt
- **Schulungen**: Kostenlose Trainings für Autoren
- **Netzwerk**: Austausch mit anderen Autoren


Los geht's!
===========

Du hast jetzt alle Infos, um zu starten.

**Du möchtest etwas beitragen?**

Kontakt zum Doku-Team:

📧 **doku-team@feuerwehr-aidlingen.de**

Wir freuen uns auf deinen Beitrag!