ORGF

Offenes Datenformat für Organisationsstrukturen und jedes Hierarchiemodell

Ein universelles, offenes Format zur Beschreibung von Hierarchiemodellen, ihren Blöcken und Tags. Es unterstützt zudem eine modellweite Wertkennzahl und Einheit für eine konsistente digitale Analyse.

FORMAT-SPEZIFIKATION

Der ORGF-Quellcode ist offen.

Auf GitHub öffnen
reference:
  format: "ORGF 1.0.0"
  syntax: "YAML|UTF-8 without BOM"

  sections_fixed:
    orgformat: "string|required"
    reference: "section|optional"
    meta: "section|required"
    model: "section|optional"
    root: "block|required"
    hierarchy: "root.children[*].children[*]..."

  meta:
    title: "string|max250|optional"
    author: "string|max250|optional"
    rights_holder: "string|max250|optional"
    copyright: "string|max500|optional"
    license: "string|max120|optional"
    created: "string|optional|YYYY-MM-DD/ISO 8601"
    updated: "string|optional|YYYY-MM-DD/ISO 8601"
    status: "draft/final/archived|optional"

  model:
    name: "string|max250|optional"
    desc: "string|max1000|optional"
    value_label: "string|max80|optional|one_value_type_per_model"
    value_unit: "string|max40|optional|one_value_unit_per_model"

  block:
    name: "string|max250|optional|empty_allowed"
    desc: "string|max500|optional"
    value: "number|optional|own_value_only"
    pic: "section|optional"
    pic.set: "emoji/lucide/feather/simple-icons/iconify|required_if_pic"
    pic.name: "string|required_if_pic"
    tags: "array[string|max80]|optional|default:[]"
    hidden: "boolean|optional|default:false"
    branch_orientation: "auto/horizontal/vertical|optional|default:auto"
    style:
      fill: "default/#HEX|optional|default:default"
      contour: "default/solid/dashed/dotted/double|optional|default:default"
      contour_width: "default/regular/bold|optional|default:default"
    relation:
      line: "default/solid/dashed/dotted|optional|default:default"
      line_width: "default/regular/bold|optional|default:default"
      color: "default/#HEX|optional|default:default"
    children: "array[block]|optional|default:[]"

  authoring_rules:
    - "one_file=one_model"
    - "hierarchy=children"
    - "no_id_parent_order"
    - "empty_blocks_allowed"
    - "tags=plain_classifiers_not_key_value"
    - "desc=short_human_note_not_data_dump"
    - "style_relation=custom_overrides_only"
    - "tag_colors_not_stored_in_orgf"
    - "value_one_type_per_model"
    - "value_one_unit_per_model"
    - "value_on_block_is_own_value_only"
    - "value_totals_are_computed_not_stored"
    - "reference_if_present=complete_unmodified_canonical_copy_published_for_declared_orgformat_version_at_https://github.com/orgformat/orgf/releases"
    - "hidden=true_on_a_block_requires_hidden=true_on_every_descendant"

  normalization:
    unknown_fields: remark
    invalid_values: default
    over_limit: truncate
    invalid_yaml: reject
    invalid_structure: reject

  normalization_rules:
    - "missing_optional=default"
    - "unknown_fields=remark"
    - "invalid_values=default"
    - "over_limit=truncate"
    - "normalization=view_only_not_source_mutation"
    - "hidden_branch_inconsistency=remark_not_reject"
    - "normalization_propagates_hidden=true_to_all_descendants"

GRUNDPRINZIPIEN

Ein offenes Format zum Beschreiben, Teilen und Integrieren von Hierarchiemodellen

ORGF hält das Modell portabel und verständlich, sodass es zwischen Menschen, Werkzeugen und Systemen wechseln kann, ohne an eine einzige Oberfläche gebunden zu sein.

UNIVERSALITÄT

Eine Logik für jede Hierarchie

Verwenden Sie dasselbe Format für Organisationsstrukturen, Kataloge, Klassifikationen, Referenzdaten, Wissensbäume und andere verschachtelte Modelle — ohne domänenspezifische Pflichtfelder.

LESBARKEIT

Eine YAML-Datei, die Menschen lesen können

Das Modell bleibt über eine Oberfläche hinaus verständlich: Öffnen, prüfen und bearbeiten Sie es als aussagekräftige Beschreibung der Struktur.

TRANSPARENZ

Struktur ohne versteckte IDs

Die Hierarchie wird direkt über Kinder ausgedrückt, ohne technische Kennungen oder Elternbeziehungen, die dem Modellautor verborgen bleiben.

INTEGRATION

Daten über eine Oberfläche hinaus austauschen

Teilen Sie Modelle mit anderen Teams, nutzen Sie sie in Daten-zu-Diagramm-Workflows und integrieren Sie ORGF in Ihre eigenen Systeme und Prozessoren.

WERT

Ein Wertemodell über die gesamte Hierarchie

Legen Sie für Blöcke einen numerischen Wert und für das Modell eine Einheit fest; Gesamtsummen werden für eine konsistente Analyse aus der Struktur berechnet.

UNABHÄNGIGKEIT

Frei nutzbar und weiterentwickelbar

ORGF ist nicht an einen bestimmten Editor, Cloud- oder Anbieterplattform gebunden. Nutzen, erweitern und entwickeln Sie eigene IT-Lösungen darum herum.

Der Modellautor bestimmt seine Lizenz

ORGF ist ein offenes und frei nutzbares Format. Rechte, Lizenz und Bedingungen eines bestimmten Modells werden vom Autor in den Metadaten des Modells angegeben.