Erklärungen in der Projektdokumentation

[StoneCodes]

Hallo,

ich hätte eine Frage zu Erklärungen von Technologien in der Projektdokumentation.
Sollten Erklärungen zu gewissen Technologien in den Anhang oder mit in den Fließtext ?
Beispiel hier eine Erklärung zum virtual DOM von React.

Zitat

[...]React nutzt zum Ändern der Elemente auf der Website ein virtuelles DOM, was bedeutet, dass im Hintergrund eine Kopie des eigentlichen DOMs vorliegt. Sobald Änderungen an einem Element z.B. durch Interaktion eines Benutzers entstehen, wird das komplette virtuelle DOM geupdated. Dieses erneuerte virtuelle DOM wird mit einem Snapshot vor der Änderung verglichen. Dieses Verfahren nennt sich „diffing“. Sobald die Änderungen erkannt worden sind, wird das richtige DOM geupdated und zwar nur die Elemente, welche auch wirklich verändert wurden[...]

Es gibt noch ein Paar weitere Erklärungen in der Doku die ähnlich wie diese Ablaufen.

Danke schon mal für eure Hilfe

Bearbeitet 14. Juni 2018 von StoneCodes

[Gast D-eath]

Wenn du es im Detail erklären kannst, falls dich jemand fragt und es für das Verständnis relevant ist, dann nimm es mit rein. Ansonsten lass es raus. Deine Projektdokumentation soll nicht für Programmierer ausgelegt sein.

[StoneCodes]

Ja ich kann soweit eigentlich alle Technologien im Detail erklären, da mach ich mir keine Sorgen.
Aber wenn ich sowas Erkläre wie im ersten Post dann eher in den Anhang oder ?

[Gast D-eath]

Ich würde es in den Anhang packen, ja. Ggf. in dein Glossar.

[Fauch]

vor 5 Stunden schrieb StoneCodes:

Hallo,

ich hätte eine Frage zu Erklärungen von Technologien in der Projektdokumentation.
Sollten Erklärungen zu gewissen Technologien in den Anhang oder mit in den Fließtext ?
Beispiel hier eine Erklärung zum virtual DOM von React.

Es gibt noch ein Paar weitere Erklärungen in der Doku die ähnlich wie diese Ablaufen.

Danke schon mal für eure Hilfe

Zwei Anmerkungen:

- Wenn du Begriffe wie DOM verwenden willst, brauchst du ein Glossar. 

- Mit denglischen Wörtern wie geupdatet wäre ich vorsichtig. "Aktualisiert" wäre hier wohl besser.

[StoneCodes]

Glossar ist vorhanden, das mit den englischen wörtern überdenk ich nochmal. Mir erschien die Erklärung hier nur zu groß für den glossar

[Fauch]

vor einer Stunde schrieb StoneCodes:

Glossar ist vorhanden, das mit den englischen wörtern überdenk ich nochmal. Mir erschien die Erklärung hier nur zu groß für den glossar

Nur, damit wir uns richtig verstehen: Die Erklärung kommt natürlich nicht in das Glossar ?