Abschlussdokumentation..bitte superschnell Antworten, da morgen in den Druck ;)

[DJMesche]

Hallöchen liebste Community der Welt

nachdem ich nun nur noch an den Quellen in meiner Dokumentation rumschreibe, ist mir etwas eingefallen:

Ich beziehe mich die ganze Zeit auf Quellen, die ich während der Programmierung des Projektes ergoogled habe...

ABER: Müssen die Quellen sich nicht eigentlich nur auf die Doku beziehen? Also muss ich nur Quellen nennen, die ich benötigt habe, um meine Doku zu verfassen?? Eigentlich ja schon?!

Da wäre die ganze Arbeit nämlich umsonst gewesen!!!

Danke für eure Hilfe!:mod:

[SaintsRow]

Wenn Du irgendwas tolles im Netz gefunden hast, was nicht auf Deinem Mist gewachsen ist, gib sicherheitshalber als Quelle mit an.

Hast Du also was in Java geschrieben, gibst Du mit hoher Wahrscheinlichkeit beispielsweise Java SE Technical Documentation an. Wenn Du zufälligerweise im Java-Unterforum der User-Foren der Ubuntu-Community fündig wurdest, weil da jemand was tolles hatte, was Du so oder so ähnlich auch bei Dir verwenden konntest, gibst Du das auch an. Bei Internetquellen kommt wegen der relativen Schnelllebigkeit (verglichen mit Büchern) hinzu, dass Du die genau URL und das Datum mit angibst. Das gleiche gilt auch für Wikipedia-Artikel und dergleichen.

[DJMesche]

Erstmal vielen Dank für die Antwort -leider wusst ich das auch vorher, und habe deswegen den Thread eröffnet

Wenn ich bei der Programmierung im Netz gesucht habe, wie ich die Parameter beim Select eines ObjectDataSource (C#) abänder, dann muss ich das doch sicherlich nicht in meine Dokumentation schreiben, da dass für die doch irrelevant ist??

[SaintsRow]

Wenn ich bei der Programmierung im Netz gesucht habe, wie ich die Parameter beim Select eines ObjectDataSource (C#) abänder, dann muss ich das doch sicherlich nicht in meine Dokumentation schreiben, da dass für die doch irrelevant ist??

Sehe ich in der Tat ähnlich. Wenn man als AE jede Internet- und Buchquelle dermaßen detailliert angeben sollte, wäre mein Quellenverzeichnis auch unendlich lang. Zumal ich oft auch nur Denkanstöße brauchte. Und dass es mittlerweile Gang und Gäbe ist, Dinge im Netz zu recherchieren (gerade für AE), sollte allen Beteiligten eigentlich klar sein.

Also Hauptquellen angeben, die Dich wirklich weitergebracht haben, irgendwo muss man aber abstufen, sehe ich auch so.

[Pixie]

Also Syntax-Googeln würde ich nicht mit aufnehmen. Und bei .NET nimmt man nun mal meist die MSDN. Wenn es um weiterführende MSDN-Artikel geht, die über bloße Syntax und Klassenbeschreibungen hinausgehen, dann schon. Oder wenn es um konkrete Sachverhalte geht, die von Bedeutung sind... konkretes Beispiel: wenn in der Klassenbeschreibung zu HttpServerUtility steht, dass das programmiergesteuerte Festlegen einer Eigenschaft gegenüber der Einstellung der web.config Vorrang hat und das im Projekt relevant ist, dann würde ich für eine solche Information auch auf eine Klassenbeschreibung verweisen.

[SaintsRow]

Ja. Danke für die Ausformulierung, irgendwie hapert es heute in meinem Kopf. Alles sehr umständlich momentan