Zum Inhalt springen

Empfohlene Beiträge

Geschrieben

Hei Leute,

habe demnächst meine Abgabe für die Doku... 

Bei meiner Durchführungsphase klingt es die ganze Zeit so als würde ich erklären, wie man vorgehen muss um es zu installieren.

Sprich ich erzähle nicht wie ich es installiert habe sondern wie es zu installieren geht.

 

Ein Beispiel bei der Beschreibung, wie man Lizenzen zuordnet.

In meiner Doku habe ich geschrieben: "Beim Aufruf der Konsole kann man sich mithilfe der Windows Authentifizierung oder mit dem klassischen Anmeldename- und Passwortverfahren anmelden. Bei erfolgreicher Anmeldung wird man auf das Dashboard weitergeleitet. Um die Lizenzen zu den Servern hinzuzufügen wählt man im Menü an der linken Seite die Option Lizenzen aus."

anstatt: "Ich habe die Konsole aufgerufen und anschließend den Menüpunkt "Lizenzen" aufgerufen".

 

Ich weiß jetzt leider nicht in welcher Form ich die Doku schreiben soll. Vielleicht könnt Ihr mir ja helfen.

 

Vielen Dank!

Geschrieben

Ich habe erstere Variante genommen. Ich erkläre teils was ich mache ("die Funktion XY wurde in das Formular YZ eingebunden") und teils was der Nutzer tun muss, so wie bei dir geschrieben.

Geschrieben

Oke vielen Dank für euer Feedback! Jetzt steh ich nochmals vor einer Frage :D

Wenn ich bei der Durchführung etwas beschreibe, wie zum Beispiel das erstellen eines Backupplans und später in der Kundendokumentation nochmals erzähle welche Schritte man genau ausführen muss um einen Plan zu erstellen wiederhole ich mich ja ein bisschen in gewisser Art und Weise ... ist das schlimm?

Geschrieben
vor 2 Stunden schrieb KeeperOfCoffee:

...es sei den es ist Vorgabe der zuständigen IHK. 

So ist es. IHK FFM wollte die ICH-Form. Frag doch bitte die zuständigen Leute bei deiner IHK da bekommst du die sicherste Antwort

Geschrieben
vor 15 Stunden schrieb BaScheu:

Wenn ich bei der Durchführung etwas beschreibe, wie zum Beispiel das erstellen eines Backupplans und später in der Kundendokumentation nochmals erzähle welche Schritte man genau ausführen muss um einen Plan zu erstellen wiederhole ich mich ja ein bisschen in gewisser Art und Weise ... ist das schlimm?

Da die Kunden deine Projektdokumentation ja nicht zu sehen bekommen, ist es völlig normal, dass sich da gewisse Teile überschneiden. Die Kundendokumentation (zumindest bei den Arbeiten, die ich kenne) ist ja sowieso im Anhang - da kann es auch mal zu Wiederholungen kommen.

  • 2 Wochen später...

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...