Diskussion über die MQL4-Dokumentation - Seite 8

 
Gorillych:
Alles ist verständlich, die Dokumentation ist da, die Beispiele sind da, Rosh hat alles geschrieben.
Das einzige, womit ich nicht zufrieden bin, sind die Beispiele in der Dokumentation. So viele dieser Beispiele wurden bereits hier auf der Website beschrieben, und die Dokumentation ist immer noch die gleiche - dumm :(

Ich schlage vor (zum dritten Mal, glaube ich), die Online-Dokumentation auf der Website um die Möglichkeit zu ergänzen , eigene Kommentare hinzuzufügen. Dies wird auch in anderen IT-Technologien erfolgreich eingesetzt.
Hier ist ein Beispiel für eine solche Funktionsbeschreibung: grundlegende, plus bereit Stücke von Code unter Dritten Entwickler - nehmen und kopieren.

 
Yurixx, was genau ist an der Dokumentation falsch? Bitte geben Sie uns einen klaren Hinweis auf Fehler und wir werden sie beheben.

Zum Beispiel gab es einen Fehler mit einem nicht spezifizierten Bezeichner, den wir bereits korrigiert haben:

Jhonny schrieb (a):
Übrigens über die Dokumentation, bemerkte ich einige seltsame Sache, wenn ich F1 auf OBJPROP_FIBOLEVELS Eigenschaft in der Dokumentation drücken, geht etwas falsch oder eher fast nichts passiert.


Aber wenn Sie eine möglichst detaillierte Dokumentation für alle Fälle wünschen, können wir das leider nicht tun. Es wird schwierig sein, das MSDN-Analogon in das Terminal einzuführen. Egal, was wir schreiben, es wird immer Fragen geben. Und selbst wenn man Artikel, eine Code-Bibliothek, ein Forum und eine Suchmaschine für all diese Dinge hat, hilft das nicht immer.


Das Thema dieses Threads hat mich dazu gebracht, einen längst überfälligen Gedanken klar zu formulieren. Der theoretische Ansatz "gib mir eine gute Dokumentation/ein gutes Buch und ich werde die Welt verändern" reicht nicht aus. Es bedarf der Übung mit dem obligatorischen und selbständigen Treten auf Schwader.

Fallbeispiel aus unserer Praxis:

Wir arbeiten seit langem an der Verbesserung der Methodik der Softwareentwicklung und bereiten uns auf die ISO9000-Zertifizierung vor. In den letzten Jahren haben wir Dutzende von Büchern zu diesem Thema gekauft, viel gelesen, und alle sind sich einig, dass die Umsetzung notwendig ist. Doch die Theorie allein reicht nicht aus. Man muss sich der Sache annehmen und es tun. Das tun wir Schritt für Schritt.

Es ist schwierig - nach der Lektüre der Bücher ist der Verstand verwirrt. Es ist der richtige Zeitpunkt, um auf die Straße zu gehen und zu rufen: "Dokumentation ist nicht gut". Sofort kam der Gedanke auf, "lass uns die Berater anrufen" und sie alles für uns erledigen lassen. Aber die Vernunft sagt uns, dass wir die Dinge selbst verstehen und verändern müssen, anstatt nur den wässrigen Bericht der Berater zu lesen.

Das ist im Geschäftsleben nicht anders. Wenn man nur Bücher liest, scheint alles ganz einfach zu sein - "an sich selbst glauben, sich aufraffen, ein Geschäft eröffnen und weiter geht's. Das Leben ist anders.

Unser Standpunkt zur Dokumentation:

  • die interaktive Schulung von Händlern weltweit über eine spezielle Website MQL4.community
  • den Händlern die Möglichkeit zu geben, sich gegenseitig zu helfen und Wissen auszutauschen
  • Ermöglichen Sie den Händlern die direkte Kommunikation mit den Entwicklern.
  • Stimulierung des Schreibens von Artikeln durch Gewerbetreibende, Übersetzung in andere Sprachen
  • Informationen an einem Ort zu sammeln, damit jeder darauf zugreifen kann

Das heißt, unsere Schulungsaufgabe ist viel umfangreicher als die einfachste integrierte Dokumentation. Gestern bin ich zum Beispiel aus Shanghai eingeflogen, wo wir unser Büro eröffnet haben, um MetaTrader in China zu fördern. In den kommenden Monaten wird es größere Änderungen im chinesischen Teil unserer Websites geben.

Werfen Sie einen breiteren Blick darauf, wie wir das tun.

 
chv:

Ich schlage vor (zum dritten Mal, glaube ich), dass die Online-Dokumentation auf der Website die Möglichkeit bieten sollte, eigene Kommentare hinzuzufügen. Dies wurde bereits in anderen IT-Technologien erfolgreich eingesetzt.
Hier ist ein Beispiel für eine solche Funktionsbeschreibung: grundlegende, plus vorgefertigte Stücke von Code unten von Drittentwicklern - nehmen Sie es und kopieren Sie es.

Ja, das ist eine gute Idee und wir werden sie höchstwahrscheinlich umsetzen.

Wir arbeiten weiter an der MQL4-Website und haben eine Menge Ideen. Morgen werden wir die Beta-Version des neuen Editors für die Website veröffentlichen. Dann wird es eine neue Version der erweiterten Funktion "Verwandte Themen" geben.
 
Ich möchte noch eine Sache sagen, dieses Thema schickt Neulinge oft zu Rosh's Artikeln, aber ich besuche es auch oft, aber ich habe es eine Weile nicht getan, weil Alpari's Seite sich ein wenig verändert hat und alle Links von hier 'Rosh's Artikel: MetaTrader 4 Experten' führen zu 404 Fehler. Ich muss also die Links korrigieren.

Natürlich habe ich die Kommentare erst später gesehen, aber der Artikel, den ich wollte, stand fast ganz oben, so dass ich ihn nicht sofort bemerkt habe.
 
Jhonny:
Ich möchte noch eine Sache sagen, dieses Thema schickt oft Neulinge zu Rosh's Artikeln, aber auch ich besuche es oft, aber ich habe es eine Weile nicht getan, weil Alpari's Seite sich ein wenig verändert hat und alle Links von hier 'Rosh's Artikel: MetaTrader 4 Experten' führen zu 404 Fehler. Ich muss diese Links also korrigieren.
Wir warten darauf, dass Alpari die Links korrigiert - sie haben es versprochen.
 
Renat:
Yurixx, was genau ist an der Dokumentation falsch? Bitte geben Sie uns einen klaren Hinweis auf die Fehler und wir werden sie beheben.

Wenn Sie eine möglichst ausführliche Dokumentation für alle Gelegenheiten haben wollen, wird dies leider nicht funktionieren. Es wird schwierig sein, MSDN analog in das Terminal einzufügen. Egal, was wir schreiben, es wird immer Fragen geben. Und selbst wenn man Artikel, eine Code-Bibliothek, ein Forum und eine Suchmaschine für all diese Dinge hat, hilft das nicht immer.

Das Thema dieses Threads hat mich dazu gebracht, einen längst überfälligen Gedanken zu formulieren. Der theoretische Ansatz "gib mir ein gutes Dokument/Buch und ich werde die Welt verändern" reicht nicht aus. Es erfordert Übung mit dem obligatorischen und selbständigen Treten auf der Harke.

Unser Standpunkt zur Dokumentation:

  • interaktive Ausbildung von Händlern weltweit über die spezielle Website MQL4.community
  • bieten Händlern die Möglichkeit, sich gegenseitig zu helfen und Wissen auszutauschen
  • Händlern die Möglichkeit geben, direkt mit den Entwicklern zu kommunizieren
  • Händler ermutigen, Artikel zu schreiben und sie in andere Sprachen zu übersetzen
  • Informationen an einem einzigen Ort zu sammeln, so dass jeder darauf zugreifen kann
Ich möchte nicht die ausführlichste Dokumentation für alle Gelegenheiten usw. haben. Es ist nur eine Frage der normalen Dokumentation. Einige der in diesem Thread geäußerten Wünsche habe ich in meinem Beitrag auf Seite 3 zusammengefasst. Der Dokumentationsteil sah wie folgt aus:

Es muss ein Kapitel geben, in dem (wie alex_ant schrieb) der Funktionsmechanismus eines MQL-Programms beschrieben wird. Das ist etwas, das jeder Händler, der neu im Programmieren ist, schon vor dem Erlernen der Sprache verstehen kann. Und diese Beschreibung muss mit dem Handelsprozess verbunden sein und kann auch den Unterschied zwischen Indikatoren, Skripten und Expert Advisors erklären, wie sie sich in Bezug auf die Tick-Queue, den Handelsserver und untereinander verhalten, usw.

Mehr Aufmerksamkeit sollte der Struktur des MQL-Programms gewidmet werden, seinen Hauptkomponenten - den init(), start() und deinit() Funktionen. Diese Funktionen sind der Hauptunterschied zwischen MQL und anderen Sprachen, und die Dokumentation räumt ihnen sehr wenig Platz ein, fast nur ein paar Zeilen.

Es wäre sehr schön, alle Einträge im Wörterbuch durchzugehen und nicht nur Fehler und Tippfehler zu beseitigen, sondern auch die Terminologie auf einen gemeinsamen Nenner zu bringen. Sehr oft werden gleiche oder ähnliche Parameter von Funktionen und Prozeduren mit ganz unterschiedlichen Begriffen beschrieben, deren Bedeutung nicht erklärt wird. Die Beschreibung liegt also vor, aber die Bedeutung und Verwendung einiger Parameter muss in einem Experiment untersucht werden.


Es ist sehr wichtig (da stimme ich 4x4ever völlig zu), die Beispiele in einer geraden Linie zu bringen! Die überwiegende Mehrheit der Beispiele in den Wörterbuchartikeln erklärt nichts und lehrt nichts. Tatsächlich ist ein einzeiliges Beispiel kein Beispiel! In einem normalen Lehrbuch können Sie anhand des Beispiels sowohl die Bedeutung der Parameter als auch die Reihenfolge, in der die Prozedur/Funktion verwendet wird, und das Ergebnis, das sie erzeugt, verstehen. Und dafür ist es nicht notwendig, ein eigenes Programm zu schreiben. IMHO ist die Schwäche der MQL Dictionary-Beispiele einer der Hauptnachteile der Dokumentation.

Sie müssen zugeben, dass das nicht viel ist.

Renat, die Haltung Ihrer Firma zur Dokumentation verdient allen Respekt. Bitte beachten Sie jedoch, dass kein einziger der von Ihnen aufgeführten Punkte in direktem Zusammenhang mit der Dokumentation steht. Sie sind alle gut, aber die Grundlage ist das Material, mit dem jeder in MQL lernt und programmiert. Gegenwärtig sind dies das Wörterbuch (d. h. die Dokumentation) und zweitens die Veröffentlichungen auf Websites. Damit das Add-on funktioniert, müssen Sie eine solide Grundlage schaffen. Das heißt, die MMS-Referenz auf die gewünschte Qualität zu bringen.
 

Renat schrieb (a):
Yurixx, was genau ist an der Dokumentation falsch? Bitte geben Sie uns einen klaren Hinweis auf die Fehler und wir werden sie beheben.


Yurixx:
Renat, die Haltung Ihrer Firma zu den Unterlagen verdient allen Respekt. Bitte beachten Sie jedoch, dass sich kein einziger der von Ihnen aufgeführten Punkte direkt auf die Dokumentation bezieht. Sie sind alle gut, aber die Grundlage ist das Material, mit dem jeder in MQL lernt und programmiert. Gegenwärtig sind dies das Wörterbuch (d. h. die Dokumentation) und zweitens die Veröffentlichungen auf Websites. Damit das Add-on funktioniert, müssen Sie eine solide Grundlage schaffen. Das heißt, die MMS-Referenz auf die gewünschte Qualität zu bringen.

Ich denke, es gibt keine eindeutigen Hinweise auf offensichtliche Fehler. Das ist sehr bedauerlich.
 
Renat:

Ich gehe davon aus, dass es keine eindeutigen Hinweise auf offensichtliche Fehler gibt. Das ist sehr bedauerlich.

Um sich die Suche nach spezifischen Fehlern zu ersparen, werden in solchen Fällen in der Regel eine Reihe mehrseitiger Verweise auf GOSTs, SNiPs und ISOs gegeben, mit dem Angebot, das Produkt in Übereinstimmung mit der angegebenen Liste zu bringen. Schade, dass ich mir die Nummern nicht merken kann und keine Lust habe, sie zu suchen, sonst würde ich dir die Liste zuwerfen ;)
Das ist ein Scherz.

Renat, welchen neuen Website-Editor haben Sie vorhin erwähnt, als Sie die Einführung der Website planten?
 
chv:

Renat, welchen neuen Editor für die Website haben Sie vorhin erwähnt, den Sie einführen wollen?
Wir haben eine neue, benutzerfreundlichere Version des Online-Editors für das Forum und den Artikelbereich erstellt. Mit dieser Version wird das Erstellen von Beiträgen wesentlich einfacher.

Eine der neuen Funktionen (noch nicht enthalten) wird das Einfügen von Videoclips sein. Sowohl Ihre eigenen Clips als auch Clips von YouTube. Höchstwahrscheinlich werden wir die öffentliche Testphase am Montag starten.
 
Renat:

Renat schrieb (a):
Yurixx, was genau ist an der Dokumentation falsch? Bitte geben Sie uns klare Hinweise auf Fehler und wir werden sie beheben.

Soweit ich weiß, gibt es keinen klaren Hinweis auf offensichtliche Fehler. Das ist sehr bedauerlich.


Du, Renat, ziehst voreilige Schlüsse. Es scheint, als wolle man wirklich lästige "Kritiker" ohne großen Aufwand loswerden. Nach der so schön verkündeten Position des Unternehmens deutet es darauf hin, dass hinter diesen Verlautbarungen in Wirklichkeit eine mangelnde Bereitschaft steht, auf die Wünsche der Nutzer zu hören. MQ weiß nämlich selbst, was zu tun ist und wie es zu tun ist, was haben die Benutzer damit zu tun?

Ich kann Ihnen versichern, dass Sie die Situation falsch einschätzen. Ich kann Ihnen sehr wohl klare Hinweise darauf geben, was verbessert werden muss. Aber lassen Sie mich zunächst etwas klarstellen. Dieser Satz, der so überzeugend rot markiert ist, suggeriert eindeutig Folgendes: Wenn Sie uns auf Fehler hinweisen, werden wir sie beheben, aber wir werden die Dokumentation nicht selbst durchsehen. Und auch die Formulierung "offensichtliche Fehler" ist suggestiv. Während der zweijährigen Fehlersuche und dank der Hilfe der Mitglieder dieses Forums wurde die Zahl der "offensichtlichen Fehler" auf ein Minimum reduziert und nimmt weiter ab. Dennoch machen Sie mit dieser Formulierung deutlich, dass Sie an Informationen über andere Fehler, die nicht "offensichtlich" sind, nicht interessiert sind. Und Sie sind auch nicht an schlechten Beispielen, unverständlich geschriebenen Erklärungen und dergleichen interessiert.

Und wollen Sie wirklich, dass ich Anweisungen zu ALLEN Dokumentationsfehlern gebe? Nein, Renat, tut mir leid. Ihr Unternehmen darf kein Handbuch über MQL schreiben - das ist in Ordnung. Aber es muss die Dokumentation über die Sprache überarbeiten. Ja, das muss es! Wer sonst als der Schöpfer der Sprache muss sie dokumentieren? Wie sonst als auf der Grundlage dieser Dokumentation können Programmierer lernen, diese Sprache zu verwenden?

Um nicht unbegründet zu sein, gebe ich Ihnen ein typisches Beispiel: Wenn Sie nicht an der Qualität der Dokumentation interessiert sind, werden Sie sicher feststellen, warum das, was ich geschrieben habe, Unsinn ist. Wenn es in diesem Gespräch ein konstruktives Element gibt, werden Sie zweifellos verstehen, was ich meine. Aber Sie wissen schon, was ich meine.

Dennoch, hier ein Beispiel.

int ArrayRange( object array[], int range_index)
Gibt die Anzahl der Elemente in der angegebenen Dimension des Arrays zurück. Da die Indizes bei Null beginnen, ist die Größe der Dimension um 1 größer als der größte Index.

Parameter:

array[] - Geprüftes Array
bereich_index - Index der Abmessungen.

Beispiel:
int dim_size; double num_array[10,10,10]; dim_size=ArrayRange(num_array, 1);
.


Normalerweise ist ein Index eine Variable, die die Elemente eines Arrays nummeriert. In diesem Fall handelt es sich nicht um einen Index, sondern um eine Indexnummer, aber aus dem Satz "Da Indizes mit Null beginnen, ist die Dimensionsgröße um 1 größer als der größte Index. "Weder dies noch irgendetwas anderes kann verstanden werden. Besonders für einen Anfänger.

Was meinen Sie mit "seit ..."? Wo wurde dies zuvor festgelegt? Nirgendwo! Denn es handelt sich um eine spezifische Funktion, und die Variablerange_index, die die Messungen nummeriert, taucht nirgendwo anders auf. Man muss also nur sagen, dass die Nummerierung der Messungen bei 0 beginnt und dass die Nummer der Messung (nicht die Größe!) um 1 größer ist als der größte Wert der Variablenrange_index (nicht "index"). Besser noch, quetschen Sie nicht alles in einen Satz, sondern erklären Sie alles in 2-3 Sätzen konsequent und verständlich.

Das in der Beschreibung genannte Beispiel ist ein Klassiker unter den Handbüchern. Was kann sie klären? Nichts! Wenn Sie, Renat, nicht wissen, wie es sein sollte, schauen Sie sich das Bild im ersten Beitrag dieser Seite an. Zumindest sollte es einen Ausdruck der Ergebnisse der im Beispiel angegebenen Operationen geben. Und welchen Wert hat die Variabledim_size daraufhin angenommen? Ich weiß, dass Sie es wissen, aber wissen auch die Sprachanfänger davon?

Und selbst wenn geschrieben würde, dass dim_size=10 ist, würde das irgendjemandem helfen, etwas zu verstehen? Der Autor dieses Beispiels hat, vielleicht nur aus humoristischen Gründen, die Zahl 10 in alle drei Dimensionen des Feldes eingetragen.

Hier ein Beispiel für die Einstellung zum Schreiben von Dokumentation. Überlegen Sie sich selbst ein Synonym für das Wort "Haltung".
Ich frage mich, wie viele "offensichtliche" Fehler Sie hier gezählt haben. Nicht ein einziger, glaube ich.
Aber ich kann Ihnen versichern, dass es noch viele weitere solcher Artikel im Handbuch gibt, die keine offensichtlichen Fehler enthalten, aber die Qualität der darin enthaltenen Dokumentation erheblich mindern.