Documentation Tutorial
Iniziare con la documentazione
Ricerca…
Versioni
| Versione | Data di rilascio |
|---|---|
| Beta privata | 2016/03/26 |
| 1 | 2016/07/25 |
| 2 | 2016/08/04 |
| 3 | 2016/08/29 |
| 4 | 2016/09/12 |
| 5 | 2016/09/29 |
| 6 | 2016/10/20 |
| 7 | 2016/11/29 |
Informazioni sulla documentazione
Cosa può essere documentato?
- Esempi di funzioni per varie lingue.
- Una breve introduzione di ogni tag.
Qual è la differenza tra una domanda e un argomento?
- Gli argomenti hanno un ambito più ampio delle domande; Gli argomenti della documentazione che vengono richiesti come domande possono essere chiusi perché sono troppo ampi.
- Gli argomenti dovrebbero avere più esempi; una richiesta che può essere servita da un argomento con un solo esempio (ad esempio un blocco di codice) è probabilmente troppo stretta.
Ciao mondo
Un argomento di ciao mondo dovrebbe consistere nel più semplice, completo, gestibile, programma di avviamento disponibile, che può essere ottenuto con la più ampia quantità di versioni della lingua, della struttura o del sistema che viene documentato. Se necessario, le osservazioni dovrebbero includere istruzioni di base su come preparare ed eseguire gli esempi.
L'argomento non dovrebbe in genere richiedere più di uno o due esempi, tranne nei casi in cui versioni successive della lingua non sono retrocompatibili. Ricorda, l'argomento ciao mondo sarà il punto di partenza per chiunque abbia appena iniziato a imparare una lingua. Come tale dovrebbe mostrare esempi di lavoro minimi che uno studente può usare per ottenere un programma corretto. Non è necessariamente un posto dove mostrare le nuove funzionalità di una lingua.