Veröffentlicht 16. Mai 20187 j 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!
16. Mai 20187 j 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.
16. Mai 20187 j Variante 2 geht schon mal eh nicht, da man die Ich-Variante nicht hernehmen sollte (jedenfalls rät ein Großteil es Forums davon ab), es sei den es ist Vorgabe der zuständigen IHK.
16. Mai 20187 j Autor Oke vielen Dank für euer Feedback! Jetzt steh ich nochmals vor einer Frage 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?
16. Mai 20187 j 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
17. Mai 20187 j 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.
30. Mai 20187 j Autor Ich stehe leider wieder auf einem Schlauch.... Würdet ihr in der Doku im Präsens schreiben oder in der Vergangenheit? Es kommt mir komisch vor in dem Projektergebnis im Präsens zu schreiben ...
Erstelle ein Konto oder melde dich an, um einen Kommentar zu schreiben.