> For the complete documentation index, see [llms.txt](https://infosys.selmotech.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://infosys.selmotech.com/selmo-documentation/8-diagnose-hmi-and-dokumentation/dokumentation-aus-dem-modell.md). # Dokumentation aus dem Modell ### Nachweis & Audit Dieses Kapitel beschreibt, **wie Dokumentation in Selmo entsteht**\ und warum sie **nicht manuell erstellt oder gepflegt werden muss**. Dokumentation ist in Selmo: * kein Zusatzaufwand * kein separates Dokument * kein nachträgliches Ergebnis Sondern: > **Eine strukturierte Sicht auf das formale Modell.** *** ### Das Grundproblem klassischer Dokumentation In klassischen Automatisierungsprojekten ist Dokumentation häufig: * zeitlich nachgelagert * vom Code entkoppelt * unvollständig oder veraltet * schwer nachvollziehbar Typische Situationen: * der Code funktioniert, die Doku ist veraltet * Änderungen werden nicht konsistent nachgezogen * Verhalten lässt sich nicht eindeutig belegen * Auditfragen müssen interpretiert werden Das Problem ist dabei **nicht mangelnde Sorgfalt**,\ sondern das Fehlen einer **gemeinsamen Quelle der Wahrheit**. *** ### Das Modell als einzige Quelle In Selmo ist das Modell diese Quelle. Das Modell enthält bereits: * Ablauf (Sequences, Zustände) * Struktur (Plant, Hardware-Zonen, Zonen) * Verhalten (Bit-Control) * Überwachung (Interlock, CMZ, Checks) * Reaktionen (Stop, Freigabe, Diagnose) Damit ist alles vorhanden, was für Dokumentation notwendig ist. > **Was im Modell beschrieben ist,**\ > **kann dokumentiert werden.**\ > **Was nicht modelliert ist,**\ > **kann nicht dokumentiert werden.** *** ### Welche Dokumentation aus dem Modell entsteht Aus dem Modell lassen sich automatisch ableiten: * Ablaufbeschreibungen\ → Zustände, Übergänge, Sequenzen * Strukturübersichten\ → Plant, Hardware-Zonen, Sequences, Zonen * Sicherheitsargumentationen\ → Interlocks, CMZ, Plausibilitätschecks * Diagnosebeschreibungen\ → Zonen, Erwartungen, Abweichungen * Bedienkonzepte\ → Hand- und Automatikbetrieb, HMI-Semantik Diese Dokumentation ist: * konsistent * aktuell * eindeutig * vollständig rückverfolgbar *** ### Nachvollziehbarkeit und Audit Durch das formale Modell ist jederzeit nachvollziehbar: * welcher Zustand aktiv ist * welche Bedingungen gelten * welche Überwachung greift * warum eine Reaktion erfolgt Für Audits bedeutet das: * keine Interpretation von Code * keine Annahmen über Verhalten * keine losgelösten Beschreibungen Stattdessen: > **Ein explizites, prüfbares Verhaltensmodell.** *** ### Dokumentation und Änderungen Änderungen erfolgen in Selmo: * am Modell * nicht an einzelnen Dokumenten Das bedeutet: * jede Änderung ist zentral * alle Ableitungen bleiben konsistent * keine divergierenden Dokumentstände > **Änderung im Modell =**\ > **Änderung in Code, Diagnose und Dokumentation.** *** ### Abgrenzung zu klassischen Dokumenten Zur Klarstellung: * Dokumentation ≠ PDF * Dokumentation ≠ Textbeschreibung * Dokumentation ≠ Kommentarsammlung Dokumentation ist: > **eine formale Darstellung des Modells**\ > **aus unterschiedlichen Blickwinkeln.** *** ### Nutzen der modellbasierten Dokumentation Durch modellbasierte Dokumentation wird: * Engineering transparenter * Betrieb sicherer * Inbetriebnahme effizienter * Auditierung einfacher * Verantwortung belegbar > **Dokumentation wird vom Pflichtdokument**\ > **zum integralen Bestandteil des Systems.** *** ### Zusammenfassung Dokumentation in Selmo: * entsteht automatisch aus dem Modell * ist immer aktuell * ist eindeutig nachvollziehbar * unterstützt Nachweis und Audit > **Wer das Modell versteht,**\ > **versteht auch die Dokumentation.** --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://infosys.selmotech.com/selmo-documentation/8-diagnose-hmi-and-dokumentation/dokumentation-aus-dem-modell.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.