From 048805302dd7a75fd9aec0b6a54b34cc5d5a184e Mon Sep 17 00:00:00 2001 From: Conrad Schulz Date: Wed, 3 Jun 2026 11:17:15 +0000 Subject: [PATCH] chore: 3-Zielgruppen-Docs + .copilot-no-tests angelegt --- .copilot-no-tests | 0 docs/ADMIN.md | 112 ++++++++++++++++++ docs/MAINTAINER.md | 105 ++++++++++++++++ docs/USER.md | 57 +++++++++ .../2026-06-03_tile-server-setup_session.md | 13 ++ 5 files changed, 287 insertions(+) create mode 100644 .copilot-no-tests create mode 100644 docs/ADMIN.md create mode 100644 docs/MAINTAINER.md create mode 100644 docs/USER.md diff --git a/.copilot-no-tests b/.copilot-no-tests new file mode 100644 index 0000000..e69de29 diff --git a/docs/ADMIN.md b/docs/ADMIN.md new file mode 100644 index 0000000..23f6b0d --- /dev/null +++ b/docs/ADMIN.md @@ -0,0 +1,112 @@ +# Administrator-Handbuch – [PROJEKT_NAME] + +> Zielgruppe: **Administratoren** – Menschen, die das System betreiben, deployen und konfigurieren. +> Voraussetzung: Grundkenntnisse in Linux, Docker und dem eingesetzten Stack. + +--- + +## Systemvoraussetzungen + + + +| Komponente | Mindestanforderung | Empfohlen | +|---|---|---| +| OS | … | … | +| RAM | … | … | +| Disk | … | … | +| Dependencies | … | … | + +--- + +## Deployment + +### Erstes Aufsetzen + + + +```bash +# Beispiel +git clone /opt/service +cd /opt/service +cp .env.example .env +# .env ausfüllen! +docker compose up -d +``` + +### Updates einspielen + + + +```bash +git pull +docker compose pull +docker compose up -d --force-recreate +``` + +--- + +## Konfiguration + +### Umgebungsvariablen (`.env`) + + + +| Variable | Pflicht | Default | Beschreibung | +|---|---|---|---| +| `EXAMPLE_VAR` | ✓ | – | Beschreibung | + +### Persistente Daten (`/data/`) + +Alle persistenten Daten liegen unter `/data//` im Repo-Root: + + + +| Pfad | Inhalt | Backup-Priorität | +|---|---|---| +| `data//` | … | hoch/mittel/niedrig | + +**Backup-Hinweise:** +- `/data/` komplett sichern vor jedem Update +- Empfehlung: tägliches Backup via Cron / Restic / rsync + +--- + +## Monitoring & Logs + + + +```bash +# Logs ansehen +docker compose logs -f + +# Status prüfen +docker compose ps +``` + +--- + +## Sicherheit + + + +- Offene Ports: … +- TLS: … +- Zugriffskontrolle: … + +--- + +## Troubleshooting + +| Symptom | Ursache | Lösung | +|---|---|---| +| … | … | … | + +--- + +## Disaster Recovery + + + +1. Dienst stoppen: `docker compose down` +2. Backup einspielen: … +3. Dienst neu starten: `docker compose up -d` diff --git a/docs/MAINTAINER.md b/docs/MAINTAINER.md new file mode 100644 index 0000000..ad8ea35 --- /dev/null +++ b/docs/MAINTAINER.md @@ -0,0 +1,105 @@ +# Maintainer-Handbuch – [PROJEKT_NAME] + +> Zielgruppe: **Entwickler & Maintainer** – Menschen, die den Code verstehen, erweitern oder reviewen. +> Voraussetzung: Entwicklungserfahrung mit dem eingesetzten Stack. + +--- + +## Architektur + + + +``` +┌──────────────────────────────────────────────────────────┐ +│ TODO: Architektur-Diagramm (ASCII oder Mermaid) │ +└──────────────────────────────────────────────────────────┘ +``` + +**Wichtige Komponenten:** + +| Komponente | Verantwortlichkeit | Ort | +|---|---|---| +| … | … | `src/…` | + +--- + +## Projektstruktur + +``` +[PROJEKT_NAME]/ +├── data/ ← Persistente Daten (gitignored) +│ └── / ← Ein Unterordner pro Service +├── docs/ +│ ├── USER.md ← Endnutzer-Dokumentation +│ ├── ADMIN.md ← Administrator-Dokumentation +│ └── MAINTAINER.md ← Dieses Dokument +├── history/ +│ ├── prompts/ ← Vollständige Agent-Konversationen (gitignored) +│ └── summary/ +│ └── PROJECT_CONTEXT.md ← Aktueller Projektzustand für Agent-Kontext +└── … ← Source Code +``` + +--- + +## Entwicklungsumgebung aufsetzen + + + +```bash +git clone +cd +# Dependencies installieren +# Dev-Server starten +``` + +--- + +## Architekturentscheidungen (ADRs) + +ADR-Dateien liegen unter `docs/adr/`. Format: `NNN-titel.md`. + +| Nr. | Titel | Status | Datum | +|---|---|---|---| +| 000 | Template | accepted | … | + +--- + +## Coding-Konventionen + + + +- **Branches:** `feat/-beschreibung`, `fix/-beschreibung` +- **Commits:** Conventional Commits (`feat|fix|chore|docs|refactor|test|ci`) +- **Tests:** `tests/` spiegelt Source-Struktur, ≥ 80% Coverage +- **Linting:** … + +--- + +## Agent-Kontext & History + +Der Agent liest beim Start immer `history/summary/PROJECT_CONTEXT.md`. +Nach Abschluss einer Aufgabe wird dort der Projektzustand aktualisiert. + +- Vollständige Konversationen: `history/prompts/` (committed – History bleibt vollständig erhalten) +- Komprimierter Kontext: `history/summary/PROJECT_CONTEXT.md` (committed) + +--- + +## Neues Feature hinzufügen + +1. `history/summary/PROJECT_CONTEXT.md` lesen – aktuellen Stand verstehen +2. Issue / Ticket anlegen +3. Branch: `git checkout -b feat/-beschreibung` +4. Implementieren + Tests schreiben +5. Dokumentation in `docs/USER.md` oder `docs/ADMIN.md` aktualisieren +6. `git commit` – Quality Gate läuft automatisch (pre-commit hook) +7. PR erstellen + Review + +--- + +## Designentscheidungen + +| Entscheidung | Begründung | +|---|---| +| … | … | diff --git a/docs/USER.md b/docs/USER.md new file mode 100644 index 0000000..de6549c --- /dev/null +++ b/docs/USER.md @@ -0,0 +1,57 @@ +# Benutzerhandbuch – [PROJEKT_NAME] + +> Zielgruppe: **Endnutzer** – Menschen, die das Produkt täglich verwenden. +> Keine Kenntnisse über interne Architektur oder Deployment notwendig. + +--- + +## Was macht dieses Projekt? + + + +--- + +## Voraussetzungen + + + +- [ ] Anforderung 1 +- [ ] Anforderung 2 + +--- + +## Erste Schritte + +### Schritt 1: Installation / Zugang + + + +### Schritt 2: Erste Nutzung + + + +--- + +## Hauptfunktionen + + + +### Feature 1 + +### Feature 2 + +--- + +## Häufige Probleme & Lösungen + + + +| Problem | Lösung | +|---------|--------| +| … | … | + +--- + +## Support + + diff --git a/history/prompts/2026-06-03_tile-server-setup_session.md b/history/prompts/2026-06-03_tile-server-setup_session.md index f7bc9fc..203c252 100644 --- a/history/prompts/2026-06-03_tile-server-setup_session.md +++ b/history/prompts/2026-06-03_tile-server-setup_session.md @@ -257,3 +257,16 @@ git push - [ ] Satellit-Download (download-satellite.py) noch nicht gestartet - [ ] NPM-Konfiguration (Cache-Header) manuell setzen - [ ] Hook auf andere Repos verteilen (install-hooks.sh fehlt noch) + +--- + +### Prompt (Copilot-Setup Agent) +Agent hat rd13_tile_server nach `git copilot-update` analysiert und fehlende Dateien nachgezogen. + +### Antwort (Copilot-Setup Agent) +Fehlende Dateien im Repo angelegt: +- `docs/USER.md`, `docs/ADMIN.md`, `docs/MAINTAINER.md` (Templates aus rd13_copilot_setup) +- `.copilot-no-tests` (kein Test-Framework, Docker/Config-Repo) + +`copilot-update.sh`/`.fish` um Schritt 4c erweitert → fehlende 3-Zielgruppen-Docs +werden künftig automatisch angelegt wenn `docs/` vorhanden ist.