Projektdoku

[cl]

Hallo Leute!

Ich hätte da mal ´ne Frage. Und zwar, meint Ihr ich könnte man-pages (UNIX/Linux) als Anhang in die Projektdokumentation mit hinein nehmen, oder ist es besser sie sinngemäß übersetzt abzutippen?

[McCaffrey]

Original geschrieben von cl

Hallo Leute!

Ich hätte da mal ´ne Frage. Und zwar, meint Ihr ich könnte man-pages (UNIX/Linux) als Anhang in die Projektdokumentation mit hinein nehmen, oder ist es besser sie sinngemäß übersetzt abzutippen?

Also, wenn die Manual Pages zu deinem Projekt unbedingt als Anhang hinzugehören kannst du sie meiner Meinung nach ruhigen Gewissen anhängen.

Anhang X - Man Page zu XXX

Eine Interessensfrage:

Warum möchtest du denn eine Man Page in den Anhang setzen?

mfg

McCaffrey

[cl]

Original geschrieben von McCaffrey

Warum möchtest du denn eine Man Page in den Anhang setzen?

Ich dachte einzelne Schritte z.B. im Umgang mit dem Logical Volume Manager können dann besser nachvollzogen werden.

Vielleicht denke ich auch zu viel.

[McCaffrey]

Hmmm,

also der Anhang sollte einen direkten Bezug zu deiner Projektdokumentation haben. Den seh ich grad bei einer Man-Page nicht.

Wenn diese Man-Page nicht unbedingt für das Verständnis des Projektes erforderlich ist, würde ich sie eher rauslassen. Zum einem bläht es deine Dokumentation auf und zum anderen wird der Anhang auch nicht unbedingt immer gelesen.

mfg

McCaffrey