Automatischer Push: 25 Datei(en) geändert
- .claude/agents/executer.md - .claude/agents/recherche.md - .claude/skills/anleitung-straffen/SKILL.md - .vault-tools/linkcheck/docs/plans/2026-09-29-waisen/00-uebersicht.md - .vault-tools/linkcheck/docs/plans/2026-09-29-waisen/task-01-zaehler.md - .vault-tools/linkcheck/docs/plans/2026-09-29-waisen/task-02-sitzungsstart.md - .vault-tools/linkcheck/docs/plans/2026-09-29-waisen/task-03-regeltexte.md - .vault-tools/linkcheck/docs/plans/2026-09-29-waisen/task-04-bestandsskript.md - .vault-tools/linkcheck/docs/plans/2026-09-29-waisen/task-05-bestandslauf.md - .vault-tools/workflow-pruefung/docs/plans/2026-09-29-quorum/00-uebersicht.md - .vault-tools/workflow-pruefung/docs/plans/2026-09-29-quorum/task-01-quorum-werkzeug.md - .vault-tools/workflow-pruefung/docs/plans/2026-09-29-quorum/task-02-quorum-workflow.md - … und 13 weitere Erzeugt vom PostToolUse-Hook .vault-tools/auto-push/auto_push.py. Co-Authored-By: Claude Opus 5 <[email protected]>
This commit is contained in:
1 parent
8e29a16e7b
commit
e8472409e9
25 files changed
+6403
-86
No files matched your search
@@ -1,11 +1,11 @@
|
||||
---
|
||||
type: resource
|
||||
status: reference
|
||||
status: pending-review
|
||||
title: Codedoku und Dateikopf
|
||||
summary: Wie Produktivdateien aussehen — Dateikopf mit genau drei Angaben, CHANGELOG statt Versionsnummern in der Datei, was aus dem Code verschwindet, was drinbleibt, und wohin die Codedoku gehört.
|
||||
tags: [regelwerk, codeworkflow, code-projekte, dokumentation]
|
||||
created: 2026-08-30
|
||||
updated: 2026-08-30
|
||||
updated: 2026-09-29
|
||||
---
|
||||
|
||||
# Codedoku und Dateikopf
|
||||
@@ -79,9 +79,16 @@ Faustregel: **was** und **wie** gehören in die Doku, **warum ausgerechnet so**
|
||||
|
||||
## Die Codedoku
|
||||
|
||||
Liegt im Projektordner unter `docs/code/`, eine Datei je Modul oder Skript, gleicher Name. Sie beantwortet vier Dinge: wofür das Ding da ist, wie der Ablauf von oben nach unten läuft, welche Annahmen es über seine Umgebung macht, und was beim Anfassen weh tut. Ton und Grenzen: [[AI/Regelwerk/schreibstil|schreibstil.md]].
|
||||
- Ort: Projektordner unter `docs/code/`, eine Datei je Modul oder Skript, gleicher Name.
|
||||
- Vier Überschriften, darunter Stichpunkte, keine Textblöcke:
|
||||
- **Wofür** — eine Zeile
|
||||
- **Ablauf** — nummerierte Liste von oben nach unten
|
||||
- **Annahmen** über die Umgebung
|
||||
- **Was beim Anfassen weh tut**
|
||||
- Form und Grenzen: [[AI/Regelwerk/schreibstil|schreibstil.md]].
|
||||
- `docs/plans/` bleibt für Umsetzungspläne, `books/` für Betriebs- und Kundendokumentation. Die Codedoku ist für den, der den Code ändert, nicht für den, der ihn benutzt.
|
||||
|
||||
`docs/plans/` bleibt wie gehabt für Umsetzungspläne. `books/` bleibt für Betriebs- und Kundendokumentation — die Codedoku ist für den, der den Code ändert, nicht für den, der ihn benutzt.
|
||||
**Code in Dokumenten ist etwas anderes als Produktivcode.** Codeblöcke in Anleitungen und Codedoku bekommen eine Kommentarzeile je Abschnitt, was er tut ([[AI/Regelwerk/schreibstil|schreibstil.md]], „Code in Dokumenten"). Die Regeln oben über Kommentare, die Code nacherzählen, gelten nur für Produktivdateien. Ein wörtlicher Auszug aus einer Produktivdatei bleibt mit seinen Kommentaren stehen; die erste Zeile kennzeichnet ihn als Auszug (`# Auszug aus <datei>`).
|
||||
|
||||
## Ausnahme: Prüfskripte
|
||||
|
||||
|
||||
Reference in new issue
Block a user