Basis aus 2nd-brain für LPIC-Prüfungsvorbereitung übernommen
Regeln, Standards, Kontextstruktur und Werkzeuge übernommen; 2nd-brain- Inhalte (Stacks, Ansible-Inventar, Architektur, Knowledge) entfernt. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
commit
7f6b8ebe07
70 files changed
+2816
No files matched your search
@@ -0,0 +1,35 @@
|
||||
# Regel: Header mit Verantwortlichen
|
||||
|
||||
> Stand: 08.10.2026 · gilt für: jede Code-, Konfigurations- und Template-Datei, die in diesem Repo entsteht
|
||||
|
||||
## Pflicht
|
||||
Jede Datei beginnt (nach Shebang bzw. `---`) mit einem Header im **bashdoc-Stil** (`## @tag`), eingerahmt von `#-----`-Linien:
|
||||
|
||||
| Tag | Pflicht | Inhalt |
|
||||
|---|---|---|
|
||||
| `@file` | ja | Dateiname |
|
||||
| `@brief` | ja | Zweck in einem Satz |
|
||||
| `@author` | ja | `Name <mail>` des verantwortlichen Menschen (aus `ai/context/responsible.md`) – nie die KI. Mehrere Autoren: Zeile `@author` wiederholen, Hauptautor zuerst |
|
||||
| `@owner` | ja | `Name <mail>` oder Rolle des fachlich Verantwortlichen (aus `responsible.md`) |
|
||||
| `@assist` | wenn KI beteiligt | `KI-unterstützt (<Modell>), geprüft von <author>` |
|
||||
| `@version` | ja | SemVer + Datum `x.y.z (TT.MM.JJJJ)` |
|
||||
| `@usage` | Scripts/Playbooks | Aufruf; Optionen bei Bash über `## @OPTIONS@` (generiert) |
|
||||
|
||||
- Agenten tragen Namen und Mail exakt wie in `responsible.md` (Spalte „Header-String“) ein. Fehlt dort ein Eintrag: Platzhalter `<AUTOR>` stehen lassen und den Bediener darauf hinweisen – **keine Namen erfinden**.
|
||||
- Bei inhaltlicher Änderung: `@version` erhöhen, Datum aktualisieren; `@author` nur ändern, wenn die Verantwortung wechselt.
|
||||
- Kommentar-Präfix je Sprache: Bash/YAML/Python `##`, Jinja `{#- … -#}`, SQL `--`. Format der Tags bleibt gleich.
|
||||
|
||||
## Vorlagen
|
||||
`ai/common/templates/` – Bash (`bash/script_template.sh`), Ansible (`ansible/playbooks/example.yml`), Docker (`docker/docker-compose.yml`).
|
||||
|
||||
## Beispiel (mehrere Autoren)
|
||||
```bash
|
||||
## @author Erika Muster <erika.muster@example.org>
|
||||
## @author Max Beispiel <max.beispiel@example.org>
|
||||
## @owner Clara Fach <clara.fach@example.org>
|
||||
```
|
||||
|
||||
## Änderungsprotokoll
|
||||
- 07.10.2026 – angelegt.
|
||||
- 08.10.2026 – `Name <mail>`-Format, mehrere `@author` erlaubt.
|
||||
- 23.10.2026 – Mandantenbezug entfernt (Einzelprojekt).
|
||||
Reference in new issue
Block a user