Discussion sur la documentation de MQL4 - page 8

 
Gorillych:
Tout est compréhensible, la documentation est là, les exemples sont là, Rosh a tout écrit.
La seule chose dont je ne suis pas satisfait, ce sont les exemples de la documentation. Tant de ces exemples ont déjà été écrits ici sur le site, et la documentation est toujours la même - idiote :(

Je propose (pour la troisième fois, je crois) d'ajouter à la documentation en ligne sur le site la possibilité d'ajouter ses propres commentaires. Cette méthode est utilisée avec succès dans d'autres technologies informatiques.
Voici un exemple d'une telle description de fonction : de base, plus des morceaux de code prêts sous les développeurs tiers - prendre et copier.

 
Yurixx, qu'est-ce qui ne va pas exactement dans la documentation ? Veuillez nous indiquer clairement les erreurs et nous les corrigerons.

Par exemple, il y a eu une erreur avec un identifiant non spécifié et nous l'avons déjà corrigée :
.

Jhonny a écrit (a) :
A propos de la documentation, j'ai remarqué une chose étrange lorsque j'appuie sur F1 sur la propriété OBJPROP_FIBOLEVELS dans la documentation, quelque chose ne va pas ou plutôt presque rien ne se passe.


Mais si vous voulez avoir la documentation la plus détaillée pour tous les cas, nous ne pouvons malheureusement pas le faire. L'insertion de l'analogue de MSDN dans le terminal sera difficile. Peu importe ce que nous écrivons, il y aura toujours des questions. Et même si vous disposez d'articles, d'une bibliothèque de codes, d'un forum et d'un moteur de recherche pour tout cela, cela ne vous aidera pas toujours.


Le sujet de ce fil de discussion m'a fait formuler clairement une pensée que j'attendais depuis longtemps. L'approche théorique "donnez-moi une bonne documentation/un bon livre et je changerai le monde" ne suffit pas. Il faut s'entraîner avec des pas obligatoires et indépendants sur le râteau.

Étude de cas tirée de notre pratique :

Nous améliorons depuis longtemps la méthodologie de développement des logiciels, et nous nous préparons également à la certification ISO9000. Ces deux dernières années, nous avons acheté des dizaines de livres sur le sujet, en avons relu beaucoup, et tous s'accordent sur la nécessité de la mise en œuvre. Mais la théorie ne suffit pas. Tu dois t'y mettre et le faire. Ce que nous faisons étape par étape.

C'est difficile - après avoir lu les livres, l'esprit est en désordre. C'est le bon moment pour sortir et crier "la documentation n'est pas bonne". Immédiatement, on s'est dit "appelons les consultants" et laissons-les tout faire pour nous ici. Mais la raison nous dit que nous devons comprendre et changer les choses nous-mêmes, et pas seulement lire le rapport larmoyant des consultants.

C'est la même chose dans les affaires. Si vous ne lisez que des livres, tout semble simple - "croire en soi, se secouer, ouvrir une entreprise et tout va bien". La vie est différente.

Notre position sur la documentation :

  • s'engager dans une formation interactive des traders au niveau mondial par le biais d'un site web spécial MQL4.community
  • donner aux commerçants la possibilité de s'entraider et de partager leurs connaissances
  • Permettre aux commerçants de communiquer directement avec les développeurs.
  • stimuler la rédaction d'articles par les traders, les traduire dans d'autres langues
  • Rassembler les informations en un seul endroit pour que chacun puisse y accéder
    .

En d'autres termes, notre tâche éducative est bien plus large que la simple documentation intégrée. Par exemple, hier, j'ai pris l'avion depuis Shanghai, où nous avons ouvert notre bureau pour promouvoir MetaTrader en Chine. Des changements majeurs seront apportés à la partie chinoise de nos sites web dans les mois à venir.

Examinez plus largement la manière dont nous nous y prenons.

 
chv:

Je propose (pour la troisième fois, je crois) que la documentation en ligne sur le site web vous permette d'ajouter vos propres commentaires. Cette méthode a été utilisée avec succès dans d'autres technologies informatiques.
Voici un exemple d'une telle description de fonction : basique, plus des morceaux de code prêts à l'emploi ci-dessous provenant de développeurs tiers - prenez-les et copiez-les.

Oui, c'est une bonne idée et nous allons très probablement la mettre en œuvre.

Nous continuons à travailler sur le site du MQL4 et avons beaucoup d'idées. Demain, nous publierons la version bêta du nouvel éditeur pour le site web. Il y aura ensuite une nouvelle version de la fonction avancée "Sujets connexes".
 
Je voudrais dire encore une chose, ce sujet envoie souvent les nouveaux venus vers les articles de Rosha, mais moi aussi je le visite souvent, mais je ne l'ai pas fait depuis un moment, parce que le site d'Alpari a un peu changé et tous les liens d'ici 'Articles de Rosh : Experts MetaTrader 4' mènent à une erreur 404. Je dois donc corriger les liens.

Bien sûr, j'ai vu les commentaires plus tard, mais l'article que je voulais était presque en haut, donc je ne l'ai pas remarqué immédiatement.
 
Jhonny:
Je voudrais dire encore une chose, ce sujet envoie souvent les nouveaux venus vers les articles de Rosha, mais moi aussi je le visite souvent, mais je ne l'ai pas fait depuis un moment, parce que le site d'Alpari a un peu changé et tous les liens d'ici 'Articles de Rosh : Experts MetaTrader 4' mènent à une erreur 404. Je dois donc corriger ces liens.
Nous attendons qu'Alpari corrige les liens - ils l'ont promis.
 
Renat:
Yurixx, qu'est-ce qui ne va pas exactement dans la documentation ? Veuillez nous donner une indication claire des erreurs et nous les corrigerons.

Si vous souhaitez disposer de la documentation la plus détaillée possible pour toutes les occasions, cela ne fonctionnera malheureusement pas. Il sera difficile d'insérer l'analogue de MSDN dans le terminal. Peu importe ce que nous écrivons, il y aura toujours des questions. Et même si vous disposez d'articles, d'une bibliothèque de codes, d'un forum et d'un moteur de recherche pour tout cela, cela ne vous aidera pas toujours.

Le sujet de ce fil de discussion m'a fait formuler clairement une réflexion que j'attends depuis longtemps. L'approche théorique "donnez-moi un bon document/livre et je vais changer le monde" ne suffit pas. Il faut s'entraîner avec des pas obligatoires et indépendants sur le râteau.

Notre position sur la documentation :

  • s'engager dans l'éducation interactive des traders à l'échelle mondiale par le biais du site web dédié MQL4.community
  • donner aux traders la possibilité de s'entraider et de partager leurs connaissances
  • donner aux traders la possibilité de communiquer directement avec les développeurs
  • encourager les traders à écrire des articles et à les traduire dans d'autres langues
  • accumuler les informations en un seul endroit afin que tout le monde puisse y accéder
Je ne veux pas avoir la documentation la plus détaillée pour toutes les occasions, etc. C'est juste une question de documentation normale. J'ai regroupé quelques souhaits exprimés dans ce fil de discussion dans mon message de la page 3. La partie documentation était la suivante :

Il doit y avoir un chapitre décrivant (comme alex_ant l'a écrit) le mécanisme de fonctionnement d'un programme MQL. C'est une chose que tout trader novice en programmation peut comprendre avant même d'avoir appris le langage. Cette description doit être liée au processus de négociation et peut également expliquer la différence entre les indicateurs, les scripts et les conseillers experts, leur comportement par rapport à la file d'attente des tick, au serveur de négociation, les uns par rapport aux autres, etc.

Il convient d'accorder plus d'attention à la structure du programme MQL, à ses principaux composants - les fonctions init(), start() et deinit(). Ces fonctions sont la principale différence entre MQL et les autres langages, et la documentation leur accorde très peu de place, presque quelques lignes seulement.

Il serait très agréable de passer en revue toutes les entrées du dictionnaire et non seulement d'éliminer les erreurs et les coquilles, mais aussi de ramener la terminologie à un dénominateur commun. Très souvent, les descriptions de paramètres identiques ou similaires de fonctions et de procédures sont faites en utilisant des termes très différents et leur signification n'est pas expliquée. Par conséquent, des descriptions sont disponibles, mais la signification et l'utilisation de certains paramètres doivent être étudiées dans le cadre d'une expérience.


Il esttrès important (tout à fait d'accord avec 4x4ever ) d'amener les exemples en ligne droite ! La grande majorité des exemples dans les articles du dictionnaire n'expliquent rien et n'enseignent rien. En fait, un exemple d'une ligne n'est pas un exemple ! Dans un manuel normal, l'exemple permet de comprendre à la fois la signification des paramètres, l'ordre dans lequel la procédure/fonction est utilisée et le résultat qu'elle produit. Et pour cela, il n'est pas nécessaire d'écrire son propre programme. IMHO : la faiblesse des exemples du dictionnaire MQL est l'un des principaux inconvénients de la documentation.

Vous devez admettre que ce n'est pas grand-chose.

Renat, la position de votre entreprise sur la documentation mérite tout le respect. Cependant, veuillez noter qu'il n'y a pas un seul élément dans les points que vous avez énumérés qui concerne directement la documentation. Ils sont tous bons, mais la base est le matériel avec lequel tout le monde apprend et programme en MQL. À l'heure actuelle, il s'agit du Dictionnaire (c'est-à-dire de la documentation) et, d'autre part, des publications sur les sites web. Pour que le complément fonctionne, vous devez établir une base solide. C'est-à-dire amener la référence MQL à la qualité requise.
 

Renat a écrit (a) :
Yurixx, qu'est-ce qui ne va pas exactement dans la documentation ? Veuillez nous donner une indication claire des erreurs et nous les corrigerons.


Yurixx:
Renat, la position de votre entreprise sur la documentation mérite tout le respect. Cependant, veuillez noter qu'il n'y a pas un seul des points que vous avez énumérés qui concerne directement la documentation. Ils sont tous bons, mais la base est le matériel avec lequel tout le monde apprend et programme en MQL. À l'heure actuelle, il s'agit du Dictionnaire (c'est-à-dire de la documentation) et, d'autre part, des publications sur les sites web. Pour que le complément fonctionne, vous devez établir une base solide. C'est-à-dire amener la référence MQL à la qualité requise.

Je pense qu'il n'y a pas d'indication claire d'erreurs évidentes. C'est dommage.
 
Renat:

Je suppose qu'il n'y a pas d'indication claire d'erreurs évidentes. C'est dommage.

Habituellement, dans de tels cas, afin de ne pas vous fatiguer:) à rechercher des erreurs spécifiques, ils donnent un tas de références de plusieurs pages aux GOST, SNiP et ISO, avec une offre pour mettre le produit en conformité avec la liste spécifiée. C'est dommage que je ne me souvienne pas des numéros et que je n'aie pas envie de les chercher, sinon je vous jetterais la liste ;)
C'est une blague.

Renat, quel nouvel éditeur de site web avez-vous mentionné plus tôt lors de la planification de son lancement ?
 
chv:

Renat, quel nouvel éditeur pour le site, dont vous avez parlé plus tôt ici, envisagez-vous de lancer ?
Nous avons créé une nouvelle version, plus conviviale, de l'éditeur en ligne pour le forum et la section des articles. Cette version facilite grandement la création de postes.

L'une des nouvelles fonctionnalités (non encore incluse) sera l'insertion de clips vidéo. Aussi bien vos propres clips que des clips de YouTube. Il est fort probable que nous lancions la version bêta publique de test lundi.
 
Renat:

Renat a écrit (a) :
Yurixx, qu'est-ce qui ne va pas exactement dans la documentation ? Veuillez fournir des indications claires sur les erreurs et nous les corrigerons.

Je comprends qu'il n'y a pas d'indication claire des erreurs évidentes. C'est dommage.


Vous, Renat, vous tirez des conclusions hâtives. Il semble que vous souhaitiez vraiment vous débarrasser sans trop d'efforts des "critiques" gênants. Après avoir si joliment proclamé la position de l'entreprise, il semble que derrière ces proclamations se cache en fait un manque de volonté d'écouter les souhaits des utilisateurs. En effet, MQ lui-même sait ce qu'il faut faire et comment le faire, qu'est-ce que les utilisateurs ont à voir là-dedans.

Je peux vous assurer que vous comprenez mal la situation. Je peux très bien vous donner des indications claires sur ce qui doit être amélioré. Mais d'abord, laissez-moi clarifier quelque chose. Cette phrase, marquée en rouge de façon si convaincante, suggère clairement ce qui suit : si vous signalez des erreurs, nous les corrigerons, mais nous ne regarderons pas la documentation nous-mêmes. Et la phrase "erreurs évidentes" est également suggestive. Au cours de 2 ans de débogage et grâce à l'aide des membres de ce forum, le nombre d'"erreurs évidentes" a été réduit au minimum et continue de diminuer. Mais vous montrez tout de même clairement avec cette phrase que vous n'êtes pas intéressé par des informations sur d'autres erreurs qui ne sont pas "évidentes". Et vous ne vous intéressez pas non plus aux mauvais exemples, aux explications rédigées de manière incompréhensible et autres.

En outre, voulez-vous vraiment que je donne des instructions sur TOUTES les erreurs de documentation ? Non Renat, désolé. Votre entreprise ne peut pas rédiger un manuel sur le MQL - c'est correct. Mais elle doit réviser la documentation sur le langage. Oui, il le faut ! Qui d'autre que le créateur de la langue doit la documenter ? Comment les programmeurs peuvent-ils apprendre à utiliser ce langage autrement que sur la base de cette documentation ?

Pour ne pas être infondé, je vais vous donner un exemple typique. Si vous ne vous intéressez pas à la qualité de la documentation, vous trouverez certainement pourquoi ce que j'ai écrit est nul. S'il y a un élément constructif dans cette conversation, vous comprendrez sans doute ce que je veux dire. Mais vous savez déjà ce que je veux dire.

Néanmoins, voici un exemple.

int ArrayRange( objet array[], int range_index)
Renvoie le nombre d'éléments dans la dimension donnée du tableau. Comme les index commencent à zéro, la taille de la dimension est supérieure de 1 à celle du plus grand index.

Paramètres :

tableau[] - Tableau vérifié
index de la gamme - Indice de dimension.

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


Normalement, un index est une variable qui numérote les éléments d'un tableau. Dans ce cas, il ne s'agit pas d'un indice, mais d'un numéro d'indice. Cependant, d'après la phrase "Comme les indices commencent par zéro, la taille de la dimension est de 1 de plus que le plus grand indice. " ni cela ni rien d'autre ne peut être compris. Surtout pour un débutant.

Que voulez-vous dire par "Depuis ..." ? Où cela a-t-il été stipulé auparavant ? Nulle part ! Car il s'agit d'une fonction spécifique et la variablerange_index, qui numérote les mesures, n'apparaît nulle part ailleurs. Il suffit donc de dire que la numérotation des mesures commence à 0. Et que le numéro de la mesure (pas la taille !) est supérieur de 1 à la plus grande valeur de la variablerange_index (pas "index"). Mieux encore, ne comprimez pas tout en une seule phrase, mais expliquez tout en 2 ou 3 phrases de manière cohérente et intelligible.

L'exemple donné dans la description est un classique du manuel. Que peut-elle clarifier ? Rien ! Si vous, Renat, ne savez pas comment cela devrait être, jetez un coup d'œil à l'image dans le premier message de cette page. Il devrait y avoir au moins une impression des résultats des opérations données dans l'exemple. Et quelle valeur a pris la variabledim_size en conséquence ? Je sais que vous le savez, mais les débutants en langues le savent-ils ?

Et même s'il était écrit que dim_size=10, cela aiderait-il quelqu'un à comprendre quoi que ce soit ? L'auteur de cet exemple, peut-être juste pour des raisons humoristiques, a mis le nombre 10 dans les trois dimensions du tableau.

Voici un exemple d'attitude à adopter pour rédiger de la documentation. Trouvez vous-même un épithète pour le mot "attitude".
Je me demande combien d'erreurs "évidentes" vous avez compté ici. Pas un seul, je crois.
Mais je peux vous assurer qu'il y a beaucoup d'autres articles de ce type dans le manuel qui ne contiennent pas d'erreurs évidentes mais qui réduisent considérablement la qualité de la documentation qu'il contient.