Hallo

Ich habe mal eine Frage. Ich bin mit meiner Doku zwar schon fertig, aber es kommen gerade ein paar Zweifel auf, ob ich den Teil der Durchführung nicht zu ausführlich geschrieben habe...

Daher ist meine Frage:

Schreibt man in die Projektdokumentation auch Befehle z.B irgendwelche Unix Kommandos, die man für die Durchführung benötigt? Bzw auch Verzeichnisangaben wo was zu finden ist und sowas?

Oder ist es eher so ein oberflächliches bla bla was man gemacht hat, ohne dass man genaue Angaben über verwendete Befehle macht?

Mal ein kurz ausgedachtes einfaches Beispiel:

"Die Netzwerkkonfiguration ist in der Datei /etc/hosts vorzunehmen und kann anschliessend mit "ifconfig -a" überprüft werden."

oder eben so:

"Die Netzwerkkonfiguration ist vorzunehmen und anschliessend auf ihre Funktionsfähigkeit zu prüfen"

Hoffe ihr könnt mir weiterhelfen :hells:

(IHK ist Frankfurt)

Also ich habe in meiner Dokumentation Unix Befehle verwendet, denn meine Zielgruppe ist eine technische Abteilung.

Trotzdem habe ich eine Art Glossar im Anhang, wo die Befehle und Optionen erklärt werden.

Hm...also meine Zielgruppe ist auch eine technische Abteilung....

Bisher habe ich zwar einen Glossar aber nicht für die Erklärung der Befehle...

Bei mir steht das genauer gesagt auch nicht im Glossar, sondern ich hab einen Extra-Punkt davor eingegliedert:

z.B.

9.5 Unix-Befehle

9.6 Glossar

Wie habt ihr anderen das ganze umgesetzt?

Hallo

...

"Die Netzwerkkonfiguration ist in der Datei /etc/hosts vorzunehmen und kann anschliessend mit "ifconfig -a" überprüft werden."

...

Ich hoffe, das hast du nicht in deine Doku geschrieben...

/etc/hosts dient ja zur Namensauflösung! /etc/network/interfaces (debian) od. /etc/conf.d/net (gentoo) sind i.d.R die Dateien, die du für die Netzwerkkonfiguration benötigst.

Wenns jetzt einfach nur ein Beispiel war... Ignorieren.

Wenn nicht... ändern.

Ich persönlich mache auch ein linuxbasiertes Projekt und überlege vielleicht Befehle in die Kunden- bzw. Betriebsdoku einzubringen. Oder du bringst halt sowas wie:

"Die Ausgabe des Befehls "bla", der die Datei "/etc/bla" nach bla prüft, sieht wie folgt aus:" ...

der letzte Post ist u.U. nicht korrekt. Auf einer Solaris Maschine bestimmt die /etc/hosts auch die IP Adresse

Ich empfehle der ersten Ansatz ... ruhig ein paar UNIX Kommandos mit reinschreiben und darauf einstellen, daß man im Fachgespräch evt. drauf angesprochen wird.

Eine UNIX Anleitung im Anhang würde ich nicht erwarten. Die Prüfer, die sowas korrigieren, können UNIX ...