Technische Dokumentation : Schreibweise

[Fokuhila]

Guten Morgen,

meine zweite frage hier dreht sich um die Tech.Doku.

Zur Erklärung: Ich verstehe darunter die Doku für den Entwickler..nicht für den Kunden...

(Ist bei mir ein Anhang)

In dieser Doku wird z.B. detailierter auf die Datenbankstruktur,und Sprachschnittstellen eingangen...

Die Frage ist, ob ich auch in solchen Anhängen auf eine "Erklärende" Schreibweise achten sollte? (wie in der projektdoku) oder so wies sich eigentlich für eine Tech.Doku gehört eben "technisch"

ich frage deshalb, weil ich nicht glaube das jeder Prüfer (und wenn ich pech habe keiner ders Liest) dann dort auch Durchsteigt...

dankbar für jeden tip

[Cheris]

Schreib am Anfang der Doku für welche Zielgruppe diese Dokumentation verfasst ist. Diese Zielgruppe sollte dann letzendlich auch etwas mit der Doku anfangen können.

[Akku]

Grundsätzlich wird zwischen drei Arten von Dokus unterschieden:

Projektdoku: Ist klar, die ist für den PA

Kundendoku: Darin erklärst Du dem DAU wie die Waschmaschine zu bedienen ist.

Systemdoku: Das was Du unter Technischer Doku verstehst. Darin erklärst Du Deinem Kollegen, wie er wo, unter Zuhilfenahme eines Schaltplans, in der Waschmaschine ein Kabel durchtrennt um höhere Reparaturkosten zu rechtfertigen.

OK?