Zum Inhalt springen
View in the app

A better way to browse. Learn more.

Fachinformatiker.de

A full-screen app on your home screen with push notifications, badges and more.

To install this app on iOS and iPadOS
  1. Tap the Share icon in Safari
  2. Scroll the menu and tap Add to Home Screen.
  3. Tap Add in the top-right corner.
To install this app on Android
  1. Tap the 3-dot menu (⋮) in the top-right corner of the browser.
  2. Tap Add to Home screen or Install app.
  3. Confirm by tapping Install.

3 Fragen zur Form

Empfohlene Antworten

Veröffentlicht

Hallo

Ich habe hier nun eine in meinen Augen schöne Dokumentation zusammengeschrieben.

Nach mehrmaligem Durchlesen fallen mir aber ein paar Probleme ins Auge.

1. Ich habe keine Tabellen bzw Grafiken in meiner Doku.

Ich meine ein Struktogramm kann ich mir sicherlich noch aus den Fingern saugen, aber sonst?

Bildschirmscreens habe ich in die Anlage verbannt da ich sonst den Rahmen von 10 Seiten gesprengt hätte. Alles was ich in der Doku in Form einer Tabelle anzubieten habe, ist ein Vergleich zwischen geplanter und tatsächlich genutzter Zeit.

2. Was ist eigentlich wenn man gerne eine etwas blumige Sprache pflegt?

Ist

"Und nun kommen wir zum Clou des Ganzen"

noch konform?

Ist nüchtern besser oder lohnt es sich den Prüfer aus seiner Lethargie zu wecken?

3. Kann man Überschriften auch

2.3 Ein guter Zeitpunkt zum speichern

oder

2.5 Statisch oder aktuell?

nennen?

Gruß MJ

Du solltest unbedingt einen sachlichen Schreibstil wählen! Ansonsten leidet das Ansehen deiner Kompetenz und damit deine Glaubwürdigkeit, und außerdem willst du ja auch eine seriöse Firma repräsentieren.

Formulierungen wie "der Clou des Ganzen" haben in der Doku nichts verloren. Oder willst du dein Projekt etwa im Teleshopping anbieten? ;)

Grafiken lockern das Gesamtbild auf, sollten aber nur da eingesetzt werden, wo sie auch eine sinnvolle Aussage im Zusammenhang mit dem Text machen, einen Sachverhalt verdeutlichen oder ergänzen. Wo es keinen Sinn macht, lass sie weg!

Zu den Überschriften: Versuche möglichst, eine sinnvolle und aussagefähige Gliederung in die Überschriften zu bringen. Du schreibst schließlich keinen Unterhaltungsroman, sondern eine Dokumentation. Anstatt "ein guter Zeitpunkt zum Speichern" wäre etwas wie "Speichern der Daten" oder "Datensicherung" angebracht, anstatt "statisch oder aktuell" eher "Auswahl des xy-Verfahrens" oder "Darstellung der abc-Daten", je nachdem, was du im folgenden Abschnitt erläuterst.

Auch wenns dir schwerfällt ;)

Für den Unterhaltungswert einer Doku gibt es keine Punkte (ganz im Gegenteil...), wohl aber für einen durchdachten Aufbau, eine aussagekräftige Vorstellung des Projekts und eine kundengerechte Darstellung.

Wie IngH schon sagte, solltest du UNBEDINGT sachlich schreiben. Das ist eine geschäftliche Dokumentation und kein Unterhaltungsroman. Du riskierst mit dieser Ausdrucksweise einen ziemlich unkompetenten Eindruck. Außerdem würdest du bestimmt einiges an Platz einsparen, wenn du sachlicher schreibst und könntest dann evtl. ein paar Grafiken in die Doku mit einbringen.

Archiv

Dieses Thema wurde archiviert und kann nicht mehr beantwortet werden.

Configure browser push notifications

Chrome (Android)
  1. Tap the lock icon next to the address bar.
  2. Tap Permissions → Notifications.
  3. Adjust your preference.
Chrome (Desktop)
  1. Click the padlock icon in the address bar.
  2. Select Site settings.
  3. Find Notifications and adjust your preference.