Discusión sobre la documentación de MQL4 - página 8

 
Gorillych:
Todo es comprensible, la documentación está ahí, los ejemplos están ahí, Rosh ha escrito todo.
Lo único que no me satisface son los ejemplos de la documentación. Muchos de estos ejemplos ya se han escrito aquí en el sitio, y la documentación sigue siendo la misma: tonta :(

Propongo (por tercera vez, creo) añadir a la documentación en línea del sitio la posibilidad de añadir los propios comentarios. Esto se utiliza con éxito en otras tecnologías de la información.
He aquí un ejemplo de la descripción de una función de este tipo: básica, además de piezas listas de código por debajo de los desarrolladores de terceros - tomar y copiar.

 
Yurixx, ¿qué es exactamente lo que falla en la documentación? Por favor, indíquenos claramente los errores y los arreglaremos.

Por ejemplo, había un error con un identificador no especificado y ya lo hemos corregido:

Jhonny escribió (a):
Por cierto sobre la documentación, he notado algo extraño cuando presiono F1 en la propiedad OBJPROP_FIBOLEVELS en la documentación, algo sale mal o más bien no pasa casi nada.


Pero si quiere tener la documentación más detallada de todos los casos, lamentablemente no podemos hacerlo. Insertar el análogo de MSDN en el terminal será difícil. No importa lo que escribamos, seguirá habiendo preguntas. Y ni siquiera el hecho de tener artículos, una biblioteca de códigos, un foro y un motor de búsqueda para todas estas cosas servirá siempre de algo.


El tema de este hilo me ha hecho formular con claridad una reflexión que hace tiempo que no se hace. El enfoque teórico "dame una buena documentación/libro y cambiaré el mundo" no es suficiente. Hay que practicar con la pisada obligatoria e independiente de los rastrillos.

Estudio de caso de nuestra práctica:

Llevamos mucho tiempo mejorando la metodología de desarrollo de software, y también nos estamos preparando para la certificación ISO9000. Desde hace un par de años hemos comprado decenas de libros sobre el tema, hemos releído muchos, todos coinciden en la necesidad de la aplicación. Pero la teoría no es suficiente. Hay que ponerse las pilas y hacerlo. Lo cual estamos haciendo paso a paso.

Es difícil: después de leer los libros tienes la cabeza hecha un lío. Es el momento de salir a gritar "la documentación no sirve". Inmediatamente se pensó "llamemos a los asesores" y dejemos que lo hagan todo por nosotros. Pero la razón nos dice que tenemos que entender y cambiar las cosas nosotros mismos, no sólo leer el informe aguado de los consultores.

Es lo mismo en los negocios. Si sólo se leen los libros, todo parece sencillo: "creer en uno mismo, sacudirse, abrir un negocio y que todo siga adelante". La vida es diferente.

Nuestra posición sobre la documentación:

  • participar en la formación interactiva de los comerciantes de todo el mundo a través de un sitio web especial MQL4.community
  • ofrecer a los comerciantes la posibilidad de ayudarse mutuamente y compartir conocimientos
  • Permitir a los comerciantes comunicarse directamente con los desarrolladores.
  • estimular la redacción de artículos por parte de los comerciantes, traducirlos a otros idiomas
  • Recoger la información en un solo lugar para que cualquiera pueda acceder a ella

Es decir, nuestra tarea de formación es mucho más amplia que la más simple documentación incorporada. Por ejemplo, ayer volé desde Shanghai, donde abrimos nuestra oficina para promover MetaTrader en China. En los próximos meses habrá cambios importantes en la parte china de nuestros sitios web.

Echa un vistazo más amplio a cómo lo estamos haciendo.

 
chv:

Propongo (por tercera vez, creo) que la documentación en línea de la página web permita añadir tus propios comentarios. Esto se ha utilizado con éxito en otras tecnologías de la información.
He aquí un ejemplo de descripción de una función de este tipo: básica, además de trozos de código listos para usar de desarrolladores de terceros - tómelos y cópielos.

Sí, es una buena idea y lo más probable es que la pongamos en práctica.

Seguimos trabajando en el sitio MQL4 y tenemos muchas ideas. Mañana lanzaremos la versión beta del nuevo editor para el sitio web. Entonces habrá una nueva versión de la función avanzada "Temas relacionados".
 
Quiero decir una cosa más, este tema a menudo envía a los novatos a los artículos de Rosha, pero yo también lo visito a menudo, pero no lo he hecho durante un tiempo, porque el sitio de Alpari ha cambiado un poco y todos los enlaces de aquí 'artículos de Rosh: expertos en MetaTrader 4' conducen a un error 404. Así que tengo que corregir los enlaces.

Por supuesto, vi los comentarios más tarde, pero el artículo que quería estaba casi al principio, así que no me di cuenta inmediatamente.
 
Jhonny:
Quiero decir una cosa más, este tema a menudo envía a los novatos a los artículos de Rosha, pero yo también lo visito a menudo, pero no lo he hecho por un tiempo, porque el sitio de Alpari ha cambiado un poco y todos los enlaces de aquí 'artículos de Rosh: expertos en MetaTrader 4' conducen a un error 404. Así que tengo que corregir estos enlaces.
Estamos a la espera de que Alpari corrija los enlaces, lo han prometido.
 
Renat:
Yurixx, ¿qué es exactamente lo que falla en la documentación? Por favor, indíquenos claramente los errores y lo solucionaremos.

Si quiere tener la documentación más detallada para todas las ocasiones, lamentablemente, esto no funcionará. Será difícil insertar el análogo de MSDN en el terminal. No importa lo que escribamos, seguirá habiendo preguntas. Y ni siquiera el hecho de tener artículos, una biblioteca de códigos, un foro y un motor de búsqueda para todas estas cosas servirá siempre de algo.

El tema de este hilo me ha hecho formular con claridad una reflexión que hace tiempo que no se hace. El enfoque teórico "dame un buen documento/libro y cambiaré el mundo" no es suficiente. Requiere práctica con la pisada obligatoria e independiente del rastrillo.

Nuestra posición sobre la documentación:

  • participar en la educación interactiva de los operadores a nivel mundial a través del sitio web dedicado MQL4.community ofrecer a
  • los operadores la oportunidad de ayudarse mutuamente y compartir
  • conocimientos
  • dar a los operadores la oportunidad de comunicarse directamente con los desarrolladores
  • animar a los operadores a escribir artículos y traducirlos a otros idiomas
  • acumular información en un solo lugar para que cualquiera pueda acceder a ella
No quiero tener la documentación más detallada para todas las ocasiones, etc. Es sólo una cuestión de documentación normal. Algunos deseos expresados en este hilo, los combiné en mi post en la página 3. La parte de la documentación era la siguiente:

Debe haber un capítulo que describa (como escribió alex_ant) el mecanismo de funcionamiento de un programa MQL. Esto es algo que todo comerciante que es nuevo en la programación puede entender incluso antes de aprender el lenguaje. Y esta descripción debe estar vinculada con el proceso de negociación, y también puede explicar la diferencia entre los indicadores, los scripts y los Asesores Expertos, cómo se comportan en relación con la cola de ticks, con el servidor de operaciones, entre sí, etc.

Hay que prestar más atención a la estructura del programa MQL, sus componentes principales - las funciones init(), start() y deinit(). Estas funciones son la principal diferencia entre MQL y otros lenguajes, y la documentación les dedica muy poco espacio, casi unas pocas líneas.

Estaría muy bien repasar todas las entradas del diccionario y no sólo eliminar los errores y las erratas, sino también llevar la terminología a un denominador común. Muy a menudo, las descripciones de los mismos o similares parámetros de las funciones y procedimientos se realizan utilizando términos muy diferentes y no se explica su significado. Como resultado, se dispone de descripciones, pero el significado y el uso de algunos parámetros tienen que ser estudiados en un experimento.


¡Esmuy importante (totalmente de acuerdo con 4x4ever ) llevar los ejemplos en línea recta ! La gran mayoría de los ejemplos de los artículos del diccionario no explican nada ni enseñan nada. De hecho, ¡un ejemplo de una línea no es un ejemplo! En un libro de texto normal, el ejemplo permite comprender tanto el significado de los parámetros como el orden en que se utiliza el procedimiento/función y el resultado que produce. Y para ello no es necesario escribir su propio programa. IMHO: la debilidad de los ejemplos del Diccionario MQL es uno de los principales inconvenientes de la documentación.

Hay que admitir que no es mucho.

Renat, la postura de tu empresa sobre la documentación merece todo el respeto. Sin embargo, tenga en cuenta que no hay ni un solo punto de los que ha enumerado que esté directamente relacionado con la documentación. Todos son buenos, pero la base es el material, con el que todos aprenden y programan en MQL. En la actualidad, son el Diccionario (es decir, la documentación) y, en segundo lugar, las publicaciones en sitios web. Para que el complemento funcione, hay que crear una base sólida. Es decir, llevar la Referencia MQL a la calidad deseada.
 

Renat escribió (a):
Yurixx, ¿qué es exactamente lo que falla en la documentación? Por favor, indíquenos claramente los errores y lo solucionaremos.


Yurixx:
Renat, la postura de tu empresa sobre la documentación merece todo el respeto. Sin embargo, tenga en cuenta que no hay ni uno solo de los puntos que ha enumerado que esté directamente relacionado con la documentación. Todos son buenos, pero la base es el material, con el que todos aprenden y programan en MQL. En la actualidad, son el Diccionario (es decir, la documentación) y, en segundo lugar, las publicaciones en sitios web. Para que el complemento funcione, hay que crear una base sólida. Es decir, llevar la Referencia MQL a la calidad deseada.

Creo que no hay ningún indicio claro de errores evidentes. Es una pena.
 
Renat:

Entiendo que no hay ninguna indicación clara de errores evidentes. Es una pena.

Por lo general, en estos casos, para no esforzarse:) en la búsqueda de errores específicos, dan un montón de referencias de varias páginas a GOST, SNiPs e ISOs, con una oferta para que el producto se ajuste a la lista especificada. Es una pena que no recuerde los números y no tenga ganas de buscarlos, si no te lanzaría la lista ;)
Es una broma.

Renat, ¿qué nuevo editor de sitios web mencionaste antes cuando planeabas lanzarlo?
 
chv:

Renat, ¿qué nuevo editor para el sitio mencionó antes aquí, planeando lanzar?
Hemos creado una nueva versión del editor en línea, más fácil de usar, para el foro y la sección de artículos. Esta versión facilita mucho la creación de posts.

Una de las nuevas funciones (aún no incluida) será la inserción de videoclips. Tanto sus propios clips como los de YouTube. Lo más probable es que lancemos la beta de prueba pública el lunes.
 
Renat:

Renat escribió (a):
Yurixx, ¿qué es exactamente lo que falla en la documentación? Por favor, indique claramente los errores y los arreglaremos.

Entiendo que no hay una indicación clara de los errores evidentes. Es una pena.


Tú, Renat, estás sacando conclusiones precipitadas. Parece que realmente quiere deshacerse de los molestos "críticos" sin demasiado esfuerzo. Después de la posición tan bellamente proclamada de la empresa, sugiere que en realidad detrás de estas proclamaciones hay una falta de voluntad para escuchar los deseos de los usuarios. De hecho, el propio MQ sabe qué hacer y cómo hacerlo, qué tienen que ver los usuarios con él.

Le aseguro que no entiende la situación. Puedo dar muy bien las indicaciones claras de lo que hay que mejorar. Pero primero, déjame aclarar algo. Esta frase, tan convincentemente marcada en rojo, sugiere claramente lo siguiente: si nos señalas los errores, los arreglaremos, pero no revisaremos la documentación nosotros mismos. Y la frase "errores obvios" también es sugerente. Durante 2 años de depuración y gracias a la ayuda de los miembros de este foro, el número de "errores obvios" se redujo al mínimo y sigue disminuyendo. Pero aun así dejas claro con esta frase que no te interesa la información sobre otros errores que no son "evidentes". Y no le interesan demasiado los malos ejemplos, las explicaciones incomprensiblemente escritas y cosas por el estilo.

Además, ¿realmente quiere que dé instrucciones sobre TODOS los errores de documentación? No Renat, lo siento. Puede que su empresa no escriba un manual sobre MQL, no pasa nada, pero debe revisar la documentación sobre el lenguaje. Sí, debe hacerlo. ¿Quién sino el creador de la lengua debe documentarla? ¿De qué otra manera, si no es sobre la base de esta documentación, pueden los programadores aprender a utilizar este lenguaje?

Así que, para no ser infundado, le pondré un ejemplo típico. Si no le interesa la calidad de la documentación, seguro que encontrará por qué lo que he escrito es una basura. Si hay algún elemento constructivo en esta conversación, sin duda entenderá lo que quiero decir. Pero ya sabes a qué me refiero.

No obstante, he aquí un ejemplo.

int ArrayRange( object array[], int range_index)
Devuelve el número de elementos en la dimensión dada del array. Como los índices comienzan en cero, el tamaño de la dimensión es 1 más que el índice mayor.

Parámetros:

array[] - Conjunto controlado
índice_de_rango - Índice de dimensión.

Ejemplo:
int tamaño_de_dim; double matriz_de_dim[10,10,10]; tamaño_de_dim=Rango_de_dim(matriz_de_dim, 1);
.


Normalmente, un índice es una variable que numera los elementos de un array. En este caso, no se trata de un índice, sino de un número de índice. Sin embargo, a partir de la frase "Como los índices empiezan por cero, el tamaño de la dimensión es 1 más que el índice mayor. " no se puede entender ni esto ni nada. Especialmente para un principiante.

¿Qué quiere decir con "Desde..."? ¿Dónde estaba estipulado esto antes? En ninguna parte. Porque se trata de una función específica y la variablerange_index, que numera las medidas, no aparece en ningún otro lugar. Por lo tanto, sólo hay que decir que la numeración de las mediciones comienza desde 0. Y el número de la medición (¡no el tamaño!) es 1 más que el mayor valor de la variablerange_index (no "índice"). Mejor aún, no lo exprima todo en una sola frase, sino explíquelo todo en 2 ó 3 frases de forma coherente e inteligible.

El ejemplo que se da en la descripción es un clásico del Manual. ¿Qué puede aclarar? ¡Nada! Si tú, Renat, no sabes cómo debería ser, mira la imagen del primer post de esta página. Al menos debería haber una impresión de los resultados de las operaciones dadas en el ejemplo. ¿Y qué valor tomó la variabledim_size como resultado? Sé que usted lo sabe, pero ¿los principiantes de la lengua lo saben?

Y aunque se escribiera que dim_size=10, ¿ayudaría a alguien a entender algo? El autor de este ejemplo, tal vez sólo por razones humorísticas, puso el número 10 en las tres dimensiones de la matriz.

He aquí un ejemplo de actitud a la hora de redactar la documentación. Piensa tú mismo en un epíteto para la palabra "actitud".
Me pregunto cuántos errores "obvios" has contado aquí. Ni uno solo, creo.
Pero le aseguro que hay muchos más artículos de este tipo en el Manual que no contienen errores evidentes pero que reducen en gran medida la calidad de la documentación que contiene.