Beschreibungen der angebotenen Scripte !

Charty

Mitglied
Registriert
14.08.02
Beiträge
217
Ort
An der Weinstraße
Hallo !

Zu jedem Script sollte man eine etwas ausführlichere Beschreibung vor dem Download einsehen können.

Wo könnte man diese etwas ausführlicheren Beschreibungen zu den einzelnen Scripten unterbringen ?

Gruss von Charty
 
@J.K

Der Gedanke kam mir auch schon. Ich will das jetzt nicht ausprobieren - ist der Upload-Manager auf .vbs fixiert? Sonst könnte man eine .txt oder .pdf mit dem Script zusammen als selbstentpackende Exe hochladen.

Gruß Jochen
 
Der Filemanager hat keine Einschränkungen.
 
Hallo!

Alternativ zum begleitenden txt-file bietet sich eine uralte Möglichkeit an, die leider im Laufe der Zeit immer mehr vernachlässigt wurde, nämlich das sorgfältige Kommentieren der Befehlszeile innerhalb des Scripts!

Dateigröße und Bearbeitungszeit spielen heutzutage keine Rolle mehr und müssen auch nicht als Gegenargument herhalten. Ist eher eine Frage der Selbstdisziplin des Programmierers! Hilft vor allem aber dem "Faulen", der beim debugging leichter eigenen Fehler findet.

Gruß

Günter

Habe ich vergessen: watscht mich - aber nicht zu hart!
 
Geht schon los ;).
Erklärungstext im Script: Da ist der Text länger, als das Script, und besonders gut lesen läßt er sich da auch nicht, dann finde ich doch besser .txt, noch besser .rtf und am besten .pdf, wo man bei Bedarf auch Screenshots unterbringen kann. Adobe PDF-Reader hat heute jeder und man könnte ihn bei Bedarf zum Download bereitstellen.
Kommentare im Quelltext:
Auch wenn ich mit dieser Meinung vielleicht alleine dastehe, der Programmierer braucht sie, so lange nicht im Team gearbeitet wird, bei diesen Zwergenscripten eigentlich nicht. Der kennt seinen Pappenheimer. Während der Arbeit sind die Kommentarzeilen wie eine Laus im Pelz, man kann so ein verwarztes Programm nicht mehr flüssig lesen. Du würdest sicher einen Roman in die Tonne treten, in dem hinter jedem Satz eine Erklärung dazu steht, was Du eben gelesen hast. Viel wichtiger und eine gute Hilfe sind Flußpläne, die scheinen ganz aus der Mode gekommen zu sein, und selbst, wenn sie irgendwo gedruckt zu sehen sind, sind sie fast ausnahmslos falsch aufgebaut. Die PAPchen stammen nämlich noch aus der Zeit, als Programmierung mehr Knechtsarbeit rechtschaffener Männer als algorithmenverliebte Informatiker-Flausen-Bastelei war. Ein modular aufgebautes Programm bleibt auch ohne Kommentare überschaubar, wer endlose IFs und ELSEs linear hintereinander wurstelt, wird früher oder später und mit zunehmender Komplexität auch mit seinen eigenen Kommentaren darin todsicher in Schwulitäten geraten. Beispiele für unrettbar zu Tode gebastelte Software hat jeder auf seinem Rechner: Windows 9x, Word, das Roxio-Zeugs, zumindest das mir Bekannte.
So, jetzt bekomme ich es von allen Seiten, das belebt den Sonnabend :).

Gruß Jochen
 
Hallo !

Ich finde, dass der Beschreibungstext im eigentlichen
Script nichts zu suchen hat.
Erläuterungen zum Script gehören meiner unmaßgeblichen Meinung
nach in eine eigene, vom Script getrennte Datei.

Der " Nur-Anwender " schaut sich den eigentlichen Inhalt
des Scriptes sowieso nicht an !

Mein Vorschlag im Downloadbereich der Scripte ein
eigenes Feld " Beschreibung " einfügen und dort
den Beschreibungstext als " rtf-Datei " ablegen.

Wenn Screeshoots erforderlich sind dann von mir aus auch PDF-Dateien.
Nicht jeder hat jedoch die Möglichkeit aus einem Windword- oder rtf-Dokument eine PDF-Datei zu erzeugen !

Gruss von Charty
 
Hallo !

Ich finde, dass der Beschreibungstext im eigentlichen
Script nichts zu suchen hat.
Erläuterungen zum Script gehören meiner unmaßgeblichen Meinung
nach in eine eigene, vom Script getrennte Datei.

Der " Nur-Anwender " schaut sich den eigentlichen Inhalt
des Scriptes sowieso nicht an !

Mein Vorschlag im Downloadbereich der Scripte ein
eigenes Feld " Beschreibung " einfügen und dort
den Beschreibungstext als " rtf-Datei " ablegen.

Wenn Screeshoots erforderlich sind dann von mir aus auch PDF-Dateien.
Nicht jeder hat jedoch die Möglichkeit aus einem Windword- oder rtf-Dokument eine PDF-Datei zu erzeugen !

Gruss von Charty


Hallo Charty!

Wer jemals, auch rudimentär, angefangen hat zu programmieren, weiß um den Wert von Dokumentation. Das geht in einer separaten Datei und das geht innerhalb des Programms. Beides hat Vor- und Nachteile. Eine Dokumentation soll nicht eine Bedienungsanleitung ersetzen, da geb ich Jochen Recht! Deshalb habe ich auch in meinem obigen Posting was von "Sorgfalt" gesagt.

PDF - Stimmt so nicht - jeder hat die Möglichkeit, alles das als pdf-Datei zu drucken, was er als pdf drucken will. Mit vielen Adobe-Programmen wird der pdf-Druckertreiber mitgeliefert, dann kann man sich solche Treiber auch kaufen. Die gibt es als - teure - Vollprogramme, billigere shareware-Progs und auch als freeware.

Googeln hilft.


Gruß

Günter
 
Hallo Günter, Charty!

Programmdokumentation und Bedienungsanleitung sind zwei paar Stiefel. Erstere kommentiert die interne Funktionsweise von Befehlen, Befehlsabschnitten oder beschreibt Hintergedanken, was das Progamm an einer Stelle mit den Daten macht oder machen soll. Sie kann nur im Programm/Skript stehen. Und sie sollte am Skriptanfang kurz (!!!) im gesamten Beschreiben, wozu das Skript dient (und so Sachen wie: Von wem, wann erstellt, Voraussetzungen für korrekten Betrieb, ...)

Die Bedienungsanleitung hat dagegen im Skript nichts zu suchen, da sie das Programm als ganzes ausführlich beschreiben muß, damit man es bedienen kann. Das beinhaltet auch die Beschreibung der Benutzerschnittstelle, also Ein- und Ausgabefenster, etc.

Gruß,

Ralf
 
Hallo !   :D

Für mich der sich in Visual Basic nicht auskennt, ist
eine " Bedienungsanleitung " wichtig !

Was kann man mit dem Script anstellen, welche
Einstellmöglichkeiten habe ich.

Maximal eine halbe DIN-A4-Seite die alles wichtige
zum Script enthält !

Ob in PDF, rtf oder Winword ist mir im Prinzip schnurz egal !   ;D

Gruss von Charty
 
Hallo!

Es wurde ein neues Dauerposting in dieser Rubrik eingerichtet. Es enthält alle derzeit downloadbaren Skripte mit Download-Link und Infos zum Skript. Alle Autoren sind hiermit angehalten, mir ausführlichere Bedienungsanleitungen ihrer Werke zukommen zu lassen, damit ich diese einbauen kann. Sollten Hardcopies zur Veranschaulichung vom Benutzerinterface notwendig sein, können die z.B. wie die Userfotos auf Joachims Webspace hochgeladen werden. In diesem Falle, mir bitte auch die entsprechenden Dateinamen und ihren Bezug im Text mitteilen.

Gruß,

Ralf
 
Hallo,
ich arbeite gerade an einer erweiterten Version meines Scriptes VCD Prepare.
Dazu mache ich dann auch eine Beschreibung etc.
Jetzt fahre ich aber erstmal am Freitag eine Woche in Urlaub :-)
Grüße Zaph
 
Zurück
Oben