Skip to content

Wer hier schreibt, schreibt öffentlich

Festgelegt am 15.08.2026: das Portal ist von Anfang an öffentlich. Das ist keine Formalie, sondern die Regel, an der jede Seite gemessen wird, bevor sie eingecheckt wird. Unter portal/docs/ gibt es keinen internen Bereich und keinen Schalter, hinter dem etwas verschwinden könnte — was dort steht, steht draußen. Interne Betriebsangaben zu Portalseiten gehören nach docs/intern/ im selben Repositorium; dieser Ordner liegt außerhalb von portal/ und wird nicht veröffentlicht. Er ist kein Versteck: wer das Repositorium lesen darf, liest ihn mit.

Diese Datei ist deshalb kurz und verbindlich.


Was hier nicht hineingehört

Kundennamen und kundenspezifische Angaben. Keine Standortnamen, keine Feldbelegungen eines bestimmten Labors, keine Netzpläne, keine Seriennummern, keine Adressen. Die LIS-Feldbelegungen der einzelnen Häuser bleiben dort, wo sie heute liegen — in ugo-plus/control/lis-specification, aus der die standortbezogenen PDF entstehen. Auf dem Portal steht das Protokoll, nicht die Belegung eines Hauses. Das ist keine Einschränkung, sondern die richtige Trennung: das Protokoll ist für alle gleich, die Belegung ist es nie.

Zugangsdaten jeder Art. Keine Kennwörter, keine Schlüssel, keine Token, auch keine Beispielkennwörter und keine Werkseinstellungen. Wenn ein Beispiel eine Anmeldung braucht, steht dort ein Platzhalter.

Offene Befunde und Vermutungen über Fremdgeräte. Ein Portal ist keine Mängelliste. Was wir am Gerät eines Herstellers vermuten, gehört in den Arbeitsvorrat, nicht auf eine Seite, die der Hersteller lesen kann.


Die drei Regeln, die aus „öffentlich" folgen

1. Kein Entwurf, der aussieht wie eine Zusage

InterfaceContracts.md führt heute drei von fünf Verträgen mit dem Stand „Draft — needs confirmation". So etwas darf hier nicht stehen, als wäre es geklärt. Zwei Wege sind erlaubt, ein dritter nicht:

Entweder der Vertrag wird vorher bestätigt und steht dann ohne Einschränkung da. Oder die Seite sagt in ihrem ersten Absatz, was daran noch nicht gilt und wer es klärt. Was nicht geht, ist ein Entwurf im Ton einer Festlegung — draußen liest das jemand als Zusage und baut dagegen.

Praktische Folge für die Reihenfolge der Arbeit: erst klären, dann veröffentlichen. Das kehrt die Reihenfolge um, die ich im Paketplan hatte, und ist eine unmittelbare Folge der Entscheidung für „öffentlich".

2. Belegt und angenommen bleiben unterscheidbar

Wir machen das im chassis-simulator bereits mit # BELEGT und # ANNAHME. Auf dem Portal gilt dasselbe, sichtbar und nicht in der Fußnote:

!!! warning "Nicht am Gerät geprüft"
    Dieser Abschnitt stammt aus der Nachbildung, nicht aus einer Messung am Gerät.
    Stand: 15.08.2026.

Eine Schnittstellenseite ohne Datum und ohne Angabe, woher sie stammt, ist in einem halben Jahr eine Behauptung.

3. Sicherheitseigenschaften: die Betriebsregel ja, die Anleitung nein

Ein Beispiel, das gleich am Anfang ansteht. Das u-IoT hat keine Authentifizierung — seine eigene Schnittstellenseite sagt das wörtlich. Auf einer öffentlichen Seite ist der Umgang damit:

Gehört hin: die Betriebsregel. „Das Modul gehört in ein geschütztes Netzsegment und darf nicht aus dem allgemeinen Kundennetz erreichbar sein." Das ist eine Anforderung an die Installation, und wer sie nicht kennt, baut sie falsch auf.

Gehört nicht hin: eine vollständige Aufstellung der ungeschützten Pfade, mit denen sich ein Ausgang schalten oder das Gerät neu starten lässt, verbunden mit der Angabe, dass nichts davon eine Anmeldung verlangt. Das ist keine Dokumentation mehr, das ist eine Anleitung.

Die Trennlinie ist nicht immer scharf. Im Zweifel: die Regel schreiben, die Aufzählung weglassen, und im Arbeitsvorrat vermerken, dass die Härtung offen ist.


Was erzeugt wird und was geschrieben wird

Erzeugt. Alles, was aus dem Quelltext folgt, wird aus dem Quelltext erzeugt und niemals abgeschrieben: die OpenAPI-Beschreibungen der Dienste, die .proto-Verträge, die Fehlercodetabellen. Eine abgeschriebene Endpunktliste ist ab dem nächsten Commit falsch, und niemand merkt es.

Geschrieben. Einstieg, Beispiele, Betriebsanleitungen, und vor allem das, was zwischen zwei Systemen gilt und in keinem von beiden steht: Verhalten bei Zeitüberschreitung, Reihenfolge der Aufrufe, wer aufräumt, wenn etwas abbricht.

Wenn du beim Schreiben merkst, dass du eine Liste aus dem Quelltext abtippst — hör auf und bau stattdessen den Export.


Sprache

Die Seiten sind auf Englisch, wie die uMe-Seiten es schon sind. Das Portal richtet sich an Integrationspartner und Entwickler, und die lesen Englisch.

Der Arbeitsvorrat, die Befunde und die internen Vermerke bleiben auf Deutsch. Das ist kein Widerspruch: das eine ist ein Produkt, das andere ist unsere Werkbank.

Ergänzung vom 13.11.2026 (Entscheidung der Geschäftsführung): Alles, was für Kunden bestimmt ist, steht in sechs Sprachen (DE, EN, FR, ES, IT, NL), und alle Sprachen tragen dieselbe Fassung. Reine IT-Seiten (Schnittstellen und API, Cloud, Konsole) dürfen nur auf Deutsch und Englisch erscheinen.