betriebsdokumentation-pruefung_v1.1

YAML-Inhalt

contract:
  name: betriebsdokumentation
  version: "2.0"
  status: active
  description: |
    Validierung von Server- und Betriebsdokumentation.
    Migriert auf Meta-Schema v1.0 am 22.12.2025.

  created: "2025-12-20"
  author: system_generated_under_supervision

  scope:
    paths:
      - "/src/View/docs/**/*.php"
    excludes:
      - "**/layout.php"
      - "**/partials/**"

  rules:
    - id: path-existence
      check_type: custom
      script: "/opt/scripts/contract-validators/path_existence.py"
      severity: critical
      description: "Dokumentierte Dateipfade müssen auf dem System existieren"

    - id: command-validity
      check_type: custom
      script: "/opt/scripts/contract-validators/command_validity.py"
      severity: critical
      description: "Dokumentierte Befehle müssen syntaktisch plausibel sein"

    - id: required-breadcrumb
      check_type: required_pattern
      patterns:
        - 'class="breadcrumb"'
        - "nav.breadcrumb"
      in_files: "docs/**/*.php"
      severity: major
      description: "Dokumentationsseiten müssen Breadcrumb haben"

    - id: required-h1
      check_type: required_pattern
      patterns:
        - "<h1>"
      in_files: "docs/**/*.php"
      severity: major
      description: "Dokumentationsseiten müssen h1 Titel haben"

    - id: terminology-dienst
      check_type: forbidden_pattern
      patterns:
        - ">Service<"
        - ">Command<"
      in_files: "docs/**/*.php"
      exclude_files:
        - "**/modul/**"
      severity: minor
      description: "Bevorzuge 'Dienst' statt 'Service' im Fließtext"

  enforcement:
    on_violation: warn

  pass_threshold:
    critical_max: 0
    major_max: 2
    minor_max: 5

Aktionen

Versionshistorie

← Zurück zur Übersicht