Zum Inhalt springen

Erklärungen in der Projektdokumentation


StoneCodes

Empfohlene Beiträge

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 von StoneCodes
Link zu diesem Kommentar
Auf anderen Seiten teilen

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.

Link zu diesem Kommentar
Auf anderen Seiten teilen

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.

Link zu diesem Kommentar
Auf anderen Seiten teilen

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 ?

Link zu diesem Kommentar
Auf anderen Seiten teilen

Dein Kommentar

Du kannst jetzt schreiben und Dich später registrieren. Wenn Du ein Konto hast, melde Dich jetzt an, um unter Deinem Benutzernamen zu schreiben.

Gast
Auf dieses Thema antworten...

×   Du hast formatierten Text eingefügt.   Formatierung wiederherstellen

  Nur 75 Emojis sind erlaubt.

×   Dein Link wurde automatisch eingebettet.   Einbetten rückgängig machen und als Link darstellen

×   Dein vorheriger Inhalt wurde wiederhergestellt.   Editor leeren

×   Du kannst Bilder nicht direkt einfügen. Lade Bilder hoch oder lade sie von einer URL.

Fachinformatiker.de, 2024 by SE Internet Services

fidelogo_small.png

Schicke uns eine Nachricht!

Fachinformatiker.de ist die größte IT-Community
rund um Ausbildung, Job, Weiterbildung für IT-Fachkräfte.

Fachinformatiker.de App

Download on the App Store
Get it on Google Play

Kontakt

Hier werben?
Oder sende eine E-Mail an

Social media u. feeds

Jobboard für Fachinformatiker und IT-Fachkräfte

×
×
  • Neu erstellen...