search

ByteHamster / PSE

OPC UA Simulator for Industrial Plants (OSIP)
Other
10 stars 1 forks source link

Dokument korrekturlesen #171

Closed Dav1dK closed 7 years ago

Dav1dK commented 7 years ago

Die Benennung von Begriffen wie Mischtank/Mixtank oder Client/Clients sollte Dokumentenübergreifend und im Dokument konsistent sein. Die Ausnahme sind Namen von Klassen, die Englisch geschrieben werden.

Dav1dK commented 7 years ago

"typische Aktionen in OSIP" (Einleitung zu den Sequenzdiagrammen) umformulieren, um herauszustellen, dass das die komplexen Abläufe sind (das Kernstück der Anwendung)

Dav1dK commented 7 years ago

Kontrollieren, dass wir überall von "mehreren Wrappern" statt von "einem Wrapper" sprechen. (Bezieht sich auf die OPC UA Wrapper)

NikoWil commented 7 years ago

An einigen Stellen haben wir in den Kommentaren im Klassendiagramm Kurzformen wie "it's" statt "it is" verwendet.

In einem formalen/ technischen Dokument sollten wir nicht die umgangssprachliche Variante nehmen. Ich hab schon einige umgewandelt, bin aber nicht sicher ob ich alle gefunden habe.

ByteHamster commented 7 years ago

Oft genug steht auch it's da, obwohl es its heißen sollte...

ByteHamster commented 7 years ago

An einigen Stellen haben wir in den Kommentaren im Klassendiagramm Kurzformen wie "it's" statt "it is" verwendet.

Done. Sind definitiv keine mehr drin (grep aufs Diagramm)

ByteHamster commented 7 years ago

Kontrollieren, dass wir überall von "mehreren Wrappern" statt von "einem Wrapper" sprechen. (Bezieht sich auf die OPC UA Wrapper)

Wir haben nur einen Wrapper. Das sagt noch nichts über die Instanzen, die man dann von den Servern erstellt.

Dav1dK commented 7 years ago

Kontrollieren, dass wir überall von "mehreren Wrappern" statt von "einem Wrapper" sprechen. (Bezieht sich auf die OPC UA Wrapper)

Wir haben nur einen Wrapper. Das sagt noch nichts über die Instanzen, die man dann von den Servern erstellt.

Wir haben den ServerWrapper und den ClientWrapper. Ich glaube darum geht es.