Allgemeine Fragen zur Dokumentation

[thubbi]

Hi,

mich würde mal interessieren ob die Dokumentation auch mit Screenshots verschmückt werden darf? Also zwischen den Texten kleine Screenshot-Ausschnitte... ?

Zudem würde ich gerne mal wissen wie arg man denn ins Detail gehen soll, muss ich wirklich 1:1 erklären wie man z.B. einen Benutzer im System anlegt?

Ich habe auch schon nach BeispielDokus gesucht, doch nichts gefunden, kann mir da jemand vielleicht Abhilfe verschaffen?

Über Antworten wäre ich dankbar.

thubbi

[robotto7831a]

Ich glaube Du verwechselst etwas. Du sollst keine Installationsanleitung sondern eine Projektdokumentation verfassen.

Frank

[pruefer_gg]

DÜRFEN tust Du schon.

Aber wie Robotto schon sagt, gehören Screenshots nicht in Deine Projektdoku, sondern in den Anhang und/ oder die Kundendokumentation.

GG

[Akku]

Zudem würde ich gerne mal wissen wie arg man denn ins Detail gehen soll, muss ich wirklich 1:1 erklären wie man z.B. einen Benutzer im System anlegt?

Dies und die dazu gehörigen Screeshots, packst du selbstverständlich in eine der Projektdoku zugehörigen Kunden- bzw. Systemdoku.