Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 

Repository files navigation

AI-Arbeitsprozess – System- & Dokumentationsrichtlinie (master.md)

Dieses Repository dient als zentrale Publikationsquelle und Referenz für die master.md – eine strukturierte System-, Dokumentations- und Verhaltensrichtlinie für moderne Unix-Umgebungen und KI-gestützte Entwicklungsprozesse.


Zweck dieses Repositories

Das Ziel dieses Projekts ist die Bereitstellung, Versionierung und Veröffentlichung der master.md. Es fungiert als Single Point of Truth (SPoT) für:

  • Verbindliche Arbeits- und Strukturkonventionen für Entwickler und autonome KI-Agenten.
  • Standardisierte Systemarchitekturen basierend auf FHS und XDG-Standards ("Clean Home").
  • Die semantische Zustandstrennung bei der Pflege von Dokumentations- und Projektdateien.

Was ist master.md?

Die Datei master.md definiert das architektonische Fundament des Arbeitsbereichs sowie die Kommunikations- und Verhaltensregeln für ausführende KI-Assistenten. Sie umfasst folgende Kernbereiche:

1. Semantische Zustandstrennung (Context- & Change-Tracking)

Um Informationsverlust und unübersichtliche Dokumente zu verhindern, teilt die master.md alle projektbezogenen Metadaten strikt nach Zeitebenen auf:

Datei Zeitebene / Fokus Zweck & Erlaubter Inhalt
README.md Gegenwart (IST) Statische Erklärung von Architektur, Sinn und Zweck des Projekts. Keine datierten Changelogs oder offenen To-Dos.
CHANGELOG.md Vergangenheit (DELTA) Chronologisch datierte Historie durchgeführter Änderungen (YYYY-MM-DD).
NOTE.md / TODO.md Zukunft (SOLL) Aktive Aufgaben, Roadmaps, offene Fragen und Entwurfsideen.
SNOWFLAKE.md Umgebung (LOKAL) Benutzer- oder hostspezifische Abweichungen und manuelle Overrides.
master.md Übergreifend (SYSTEM) Zentrale Systemrichtlinie, Verzeichnislayouts und Konventionen.

Important

Agenten-Schutzregel (Mandatory Agent Veto): KI-Agenten sind verpflichtet zu intervenieren, wenn historische Änderungsprotokolle oder offene Aufgaben in eine README.md geschrieben werden sollen, und leiten die Ablage in CHANGELOG.md bzw. NOTE.md ein.

2. "Clean Home"-Architektur & 100% XDG-Konformität

Das Benutzerverzeichnis (~/) bleibt frei von lose abgelegten Dotfiles und Cache-Ordnern. Sämtliche Konfigurationen, Zustandsdaten und Caches werden konsequent über XDG-Basisvariablen ($XDG_CONFIG_HOME, $XDG_DATA_HOME, $XDG_STATE_HOME, $XDG_CACHE_HOME) und Tool-Homes (ZDOTDIR, BASHHOME, CARGO_HOME, GOPATH, etc.) umgeleitet.

3. Einheitliche Verzeichnishierarchie (FHS & XDG)

  • System-Ebene (/opt/, /srv/): Getrennte Verzeichnisse für standalone Software (/opt/) sowie Netzwerk- und Container-Infrastruktur (/srv/infrastructure/, /srv/smb/, /srv/git/).
  • User-Ebene (~/, ~/.local/):
    • ~/.local/src/: Alle Git-verwalteten Repositories und Quelltexte.
    • ~/.local/srv/: Eigene Daten, Medien (media/), Bürounterlagen (buero/), Dokumentation (docs/) und Backups (backups/).
    • ~/.local/bin/: Eigene ausführbare Skripte und Binärdateien.

4. Modulare Shell-Architektur & Bootstrapping

Klare Ladereihenfolge über ~/.profile als gemeinsamen Einstiegspunkt mit modularer Aufteilung für Zsh (conf.d/*), Bash (config.d/*) und universelle Unix-Module (~/.config/shell/*).

5. Namenskonventionen & Backup-Strategien

  • Sortierbare Zeitstempel nach ISO-8601 (YYYY-MM-DD_<name>, HH:MM:SS_<name>).
  • Eindeutige Suffixe für Konfigurationswartung: .bak (Sicherungsstand vor Änderung), .old (archivierter Stand), .break (fehlerhafte Konfiguration).

6. Usability & Copy-Paste-Qualität

Codeblöcke, Konfigurationen und Shell-Befehle werden ohne überflüssige Einrückungen ab Spalte 0 formatiert, um fehlerfreies Kopieren ins Terminal zu garantieren.


Dateistruktur dieses Repositories

ai-arbeitsprozess/
├── README.md    # Projektübersicht und Erklärung (diese Datei)
└── master.md    # Die vollständige System- & Dokumentationsrichtlinie

Verwendung & Einbindung

  1. Als KI-Systemprompt / Regeldatei: Die master.md kann direkt in Agenten-Regeln (z. B. .gemini/rules/, .cursorrules, Systemprompts) eingebunden werden, um konsistentes Verhalten autonomer Assistenten sicherzustellen.
  2. Als Systemdokumentation: Bereitstellung im lokalen Dokumentationsbaum (z. B. unter ~/.local/srv/docs/pages/master.md), einsehbar über CLI-Tools wie glow oder Shell-Aliase (lsmaster).

About

Structured system, directory (XDG/FHS), and documentation standard (master.md) for modern Unix environments and AI-assisted workflows.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Contributors