Discussione sulla documentazione MQL4 - pagina 8

 
Gorillych:
Tutto è comprensibile, la documentazione è lì, gli esempi sono lì, Rosh ha scritto tutto.
L'unica cosa di cui non sono soddisfatto sono gli esempi nella documentazione. Molti di questi esempi sono già stati scritti qui sul sito, e la documentazione è ancora la stessa - stupida :(

Propongo (per la terza volta, credo) di aggiungere alla documentazione online del sito la possibilità di aggiungere i propri commenti. Questo è usato con successo in altre tecnologie informatiche.
Ecco un esempio di descrizione di una tale funzione: di base, più pezzi di codice pronti sotto gli sviluppatori di terze parti - prendere e copiare.

 
Yurixx, cosa c'è esattamente di sbagliato nella documentazione? Vi preghiamo di darci una chiara indicazione degli errori e noi li correggeremo.

Per esempio, c'era un errore con un identificatore non specificato e l'abbiamo già corretto:

Jhonny ha scritto (a):
A proposito della documentazione, ho notato una cosa strana quando premo F1 sulla proprietà OBJPROP_FIBOLEVELS nella documentazione, qualcosa va storto o meglio non succede quasi niente.


Ma se volete avere la documentazione più dettagliata per tutti i casi, purtroppo non possiamo farlo. Inserire l'analogo MSDN nel terminale sarà difficile. Non importa cosa scriviamo, ci saranno ancora domande. E anche avere articoli, una libreria di codici, un forum e un motore di ricerca per tutte queste cose non sempre aiuta.


L'argomento di questo thread mi ha fatto formulare chiaramente un pensiero che mancava da tempo. L'approccio teorico "datemi una buona documentazione/libro e cambierò il mondo" non è sufficiente. Ci vuole pratica con il passo obbligatorio e indipendente sui rastrelli.

Un caso di studio dalla nostra pratica:

Abbiamo migliorato la metodologia di sviluppo del software per molto tempo, e ci stiamo anche preparando per la certificazione ISO9000. Negli ultimi due anni abbiamo acquistato decine di libri sull'argomento, riletto molto, tutti d'accordo sulla necessità dell'implementazione. Ma la teoria non è sufficiente. Dovete mettervi al lavoro e farlo. Cosa che stiamo facendo passo dopo passo.

È difficile - dopo aver letto i libri la mente è un casino. È il momento giusto per uscire e gridare "la documentazione non va bene". Immediatamente il pensiero "chiamiamo i consulenti" e lasciamo che facciano tutto per noi qui. Ma la ragione ci dice che dobbiamo capire e cambiare noi stessi le cose, non solo leggere il rapporto acquoso dei consulenti.

È lo stesso negli affari. Se si leggono solo libri, sembra tutto semplice - "credi in te stesso, scuoti, apri un business e tutto va avanti". La vita è diversa.

La nostra posizione sulla documentazione:

  • per impegnarsi nella formazione interattiva dei commercianti a livello globale attraverso uno speciale sito web MQL4.community
  • fornire ai commercianti la possibilità di aiutarsi a vicenda e condividere le conoscenze
  • Permettere ai commercianti di comunicare direttamente con gli sviluppatori.
  • stimolare la scrittura di articoli da parte dei commercianti, tradurli in altre lingue
  • Raccogliere le informazioni in un unico posto in modo che chiunque possa accedervi

Cioè, il nostro compito educativo è molto più ampio della più semplice documentazione integrata. Per esempio, ieri ho volato da Shanghai, dove abbiamo aperto il nostro ufficio per promuovere MetaTrader in Cina. Ci saranno grandi cambiamenti alla parte cinese dei nostri siti nei prossimi mesi.

Date uno sguardo più ampio a come lo stiamo facendo.

 
chv:

Propongo (per la terza volta, credo) che la documentazione online sul sito web permetta di aggiungere i propri commenti. Questo è stato usato con successo in altre tecnologie informatiche.
Ecco un esempio di descrizione di una tale funzione: di base, più pezzi di codice pronti qui sotto da sviluppatori terzi - prendeteli e copiateli.

Sì, è una buona idea e molto probabilmente la implementeremo.

Continuiamo a lavorare sul sito MQL4 e abbiamo molte idee. Domani rilasceremo la versione beta del nuovo editor per il sito web. Poi ci sarà una nuova versione della funzione avanzata "Argomenti correlati".
 
Voglio dire un'altra cosa, questo argomento manda spesso i neofiti agli articoli di Rosha, ma anche io lo visito spesso, ma non lo faccio da un po', perché il sito di Alpari è cambiato un po' e tutti i link da qui 'articoli di Rosh: esperti di MetaTrader 4' portano all'errore 404. Quindi devo correggere i link.

Naturalmente ho visto i commenti dopo, ma l'articolo che volevo era quasi in cima, quindi non l'ho notato subito.
 
Jhonny:
Voglio dire un'altra cosa, questo argomento manda spesso i neofiti agli articoli di Rosha, ma anche io lo visito spesso, ma non lo faccio da un po', perché il sito di Alpari è cambiato un po' e tutti i link da qui 'articoli di Rosh: esperti di MetaTrader 4' portano all'errore 404. Quindi devo correggere questi link.
Stiamo aspettando che Alpari corregga i link - l'hanno promesso.
 
Renat:
Yurixx, cosa c'è esattamente di sbagliato nella documentazione? Per favore, dateci una chiara indicazione degli errori e noi li sistemeremo.

Se volete avere la documentazione più dettagliata per tutte le occasioni, purtroppo questo non funzionerà. Sarà difficile inserire l'analogo di MSDN nel terminale. Non importa cosa scriviamo, ci saranno ancora domande. E anche avere articoli, una libreria di codici, un forum e un motore di ricerca per tutte queste cose non sempre aiuta.

L'argomento di questo thread mi ha fatto formulare chiaramente un pensiero che mancava da tempo. L'approccio teorico "datemi una buona documentazione/libro e cambierò il mondo" non è sufficiente. Richiede una pratica con passo obbligatorio e indipendente sul rastrello.

La nostra posizione sulla documentazione:

  • impegnarsi nell'educazione interattiva dei trader a livello globale attraverso il sito web dedicato MQL4.community
  • fornire ai trader l'opportunità di aiutarsi a vicenda e condividere le conoscenze
  • dare ai trader l'opportunità di comunicare direttamente con gli sviluppatori
  • incoraggiare i trader a scrivere articoli e tradurli in altre lingue
  • accumulare informazioni in un unico luogo in modo che chiunque possa accedervi
Non voglio avere la documentazione più dettagliata per tutte le occasioni, ecc. È solo una questione di documentazione normale. Alcuni desideri espressi in questo thread, li ho combinati nel mio post a pagina 3. La parte di documentazione era la seguente:

Ci deve essere un capitolo che descrive (come ha scritto alex_ant) il meccanismo di funzionamento di un programma MQL. Questo è qualcosa che ogni trader che è nuovo alla programmazione può capire anche prima di imparare il linguaggio. E questa descrizione deve essere legata al processo di trading, e può anche spiegare la differenza tra indicatori, script e Expert Advisors, come si comportano in relazione alla coda di tick, al server di trading, tra loro, ecc.

Si dovrebbe prestare maggiore attenzione alla struttura del programma MQL, i suoi componenti principali - le funzioni init(), start() e deinit(). Queste funzioni sono la principale differenza tra MQL e altri linguaggi, e la documentazione dà loro poco spazio, quasi solo poche righe.

Sarebbe molto bello passare attraverso tutte le voci del dizionario e non solo eliminare errori e refusi, ma anche portare la terminologia a un denominatore comune. Molto spesso le descrizioni di parametri uguali o simili di funzioni e procedure sono fatte usando termini molto diversi e il loro significato non è spiegato. Di conseguenza, le descrizioni sono disponibili, ma il significato e l'uso di alcuni parametri devono essere studiati in un esperimento.


È molto importante (totalmente d'accordo con 4x4ever ) portare gli esempi in linea retta! La stragrande maggioranza degli esempi negli articoli del dizionario non spiegano nulla e non insegnano nulla. Infatti, un esempio di una riga non è un esempio! In un normale libro di testo, l'esempio permette di capire sia il significato dei parametri, sia l'ordine in cui la procedura/funzione viene usata, e il risultato che produce. E per questo non è necessario scrivere il proprio programma. IMHO: la debolezza degli esempi di MQL Dictionary è uno dei principali svantaggi della documentazione.

Bisogna ammettere che non è molto.

Renat, la posizione del tuo studio sulla documentazione merita tutto il rispetto. Tuttavia, si prega di notare che non c'è una sola voce nei punti che avete elencato che si riferisce direttamente alla documentazione. Sono tutti buoni, ma la base è il materiale, con cui tutti imparano e programmano in MQL. Attualmente, questi sono il Dizionario (cioè la documentazione) e, in secondo luogo, le pubblicazioni su siti web. Per far funzionare l'add-on, è necessario creare una solida base. Cioè, portare il Riferimento MQL alla qualità desiderata.
 

Renat ha scritto (a):
Yurixx, cosa c'è esattamente di sbagliato nella documentazione? Per favore, dateci una chiara indicazione degli errori e noi li sistemeremo.


Yurixx:
Renat, la posizione del tuo studio sulla documentazione merita tutto il rispetto. Tuttavia, notate che non ce n'è uno solo nei punti che avete elencato che si riferisca direttamente alla documentazione. Sono tutti buoni, ma la base è il materiale, con cui tutti imparano e programmano in MQL. Attualmente, questi sono il Dizionario (cioè la documentazione) e, in secondo luogo, le pubblicazioni su siti web. Per far funzionare l'add-on, è necessario creare una solida base. Cioè, portare il Riferimento MQL alla qualità richiesta.

Penso che non ci sia una chiara indicazione di errori evidenti. È un peccato.
 
Renat:

Immagino che non ci sia una chiara indicazione di errori evidenti. È un peccato.

Di solito in questi casi, per non sforzarvi:) a cercare errori specifici, danno un mucchio di riferimenti a GOST, SNiP e ISO su più pagine, con un'offerta di portare il prodotto in conformità con l'elenco specificato. Peccato che non ricordo i numeri e non ho voglia di cercarli, altrimenti ti tirerei la lista ;)
È uno scherzo.

Renat, di quale nuovo editor di siti web hai parlato prima quando hai pianificato il lancio?
 
chv:

Renat, quale nuovo editore per il sito ha menzionato prima qui, ha intenzione di lanciare?
Abbiamo fatto una nuova versione più facile da usare dell'editor online per il forum e la sezione articoli. Questa versione rende molto più facile la creazione di post.

Una delle nuove funzionalità (non ancora inclusa) sarà l'inserimento di video clip. Sia le tue clip che quelle di YouTube. Molto probabilmente lanceremo la beta pubblica di prova lunedì.
 
Renat:

Renat ha scritto (a):
Yurixx, cosa c'è esattamente di sbagliato nella documentazione? Si prega di fornire indicazioni chiare sugli errori e noi li correggeremo.

Capisco che non ci sia una chiara indicazione di errori evidenti. È un peccato.


Tu, Renat, stai saltando alle conclusioni. Sembra che si voglia davvero sbarazzarsi dei fastidiosi "critici" senza troppi sforzi. Dopo una così bella posizione proclamata della società, suggerisce che in realtà dietro questi proclami c'è una mancanza di volontà di ascoltare i desideri degli utenti. Infatti, MQ stesso sa cosa fare e come farlo, cosa c'entrano gli utenti.

Posso assicurarvi che avete frainteso la situazione. Posso benissimo darvi chiare indicazioni su ciò che deve essere migliorato. Ma prima, lasciatemi chiarire una cosa. Questa frase, così convincentemente segnata in rosso, suggerisce chiaramente quanto segue: se ci fate notare degli errori, li correggeremo, ma non guarderemo noi stessi la documentazione. E anche la frase "errori evidenti" è suggestiva. Durante 2 anni di debugging e grazie all'aiuto dei membri di questo forum, il numero di "errori evidenti" è stato ridotto al minimo e continua a diminuire. Ma ancora si fa capire con questa frase che non si è interessati a informazioni su altri errori che non sono "ovvi". E non ti interessano nemmeno i cattivi esempi, le spiegazioni scritte in modo incomprensibile e simili.

Inoltre, vuoi davvero che dia istruzioni su TUTTI gli errori di documentazione? No Renat, mi dispiace. La vostra azienda non può scrivere un manuale su MQL - va bene, ma deve rivedere la documentazione sul linguaggio. Sì, deve! Chi altro se non il creatore della lingua deve documentarla? Come possono i programmatori imparare a usare questo linguaggio se non sulla base di questa documentazione?

Quindi, per non essere infondato, vi darò un esempio tipico. Se non vi interessa la qualità della documentazione, troverete sicuramente perché quello che ho scritto è spazzatura. Se c'è qualche elemento costruttivo in questa conversazione, capirete senza dubbio cosa intendo. Ma tu sai già cosa voglio dire.

Tuttavia, ecco un esempio.

int ArrayRange( oggetto array[], int range_index)
Restituisce il numero di elementi nella dimensione data dell'array. Poiché gli indici iniziano a zero, la dimensione è 1 in più dell'indice più grande.

Parametri:

array[] - Matrice controllata
indice di gamma - Indice delle dimensioni.

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


Normalmente, un indice è una variabile che numera gli elementi di una matrice. In questo caso, non è un indice, ma un numero di indice. Tuttavia, dalla frase "Poiché gli indici iniziano con zero, la dimensione è 1 in più dell'indice più grande. "Non si capisce né questo né altro. Soprattutto per un principiante.

Cosa vuol dire "Da quando..."? Dove è stato stipulato questo prima? Da nessuna parte! Perché questa è una funzione specifica e la variabilerange_index, che numera le misure, non appare altrove. Quindi basta dire che la numerazione delle misure parte da 0. E il numero della misura (non la dimensione!) è 1 in più del valore più grande della variabilerange_index (non "index"). Meglio ancora, non stringete tutto in una frase, ma spiegate tutto in 2-3 frasi in modo coerente e comprensibile.

L'esempio dato nella descrizione è un classico da manuale. Cosa può chiarire? Niente! Se tu, Renat, non sai come dovrebbe essere, guarda l'immagine nel primo post di questa pagina. Almeno dovrebbe esserci una stampa dei risultati delle operazioni date nell'esempio. E quale valore ha preso la variabiledim_size come risultato? So che tu lo sai, ma i principianti delle lingue lo sanno?

E anche se fosse scritto che dim_size=10, aiuterebbe qualcuno a capire qualcosa? L'autore di questo esempio, forse solo per ragioni umoristiche, ha messo il numero 10 in tutte e tre le dimensioni dell'array.

Ecco un esempio di attitudine a scrivere documentazione. Pensate voi stessi a un epiteto per la parola "atteggiamento".
Mi chiedo quanti errori "evidenti" hai contato qui. Nemmeno uno, credo.
Ma vi posso assicurare che ci sono molti più articoli di questo tipo nel Manuale che non contengono errori evidenti, ma riducono notevolmente la qualità della documentazione che contiene.
Motivazione: