Guida per scrivere una guida
0.1
Sommario
1. Il progetto
2. Scrivere il testo
3. Gestire modifiche e versioni
4. Condividere i sorgenti
5. Pubblicare la guida
6. Bibliografia
7. Ringraziamenti
8. Download sorgenti e binari
9. Note legali
Guida per scrivere una guida
Docs
»
Una guida per creare guide
Una guida per creare guide
¶
Sommario
¶
1. Il progetto
1.1. Installare il software necessario
1.1.1. Python per Windows
1.1.2. Sphinx-build
1.1.3. MikTex
1.2. Preparare la cartella di sviluppo
1.2.1. Il file di configurazione
1.2.2. Il file index
1.2.3. Il file di licenza per i PDF
2. Scrivere il testo
2.1. Corsivo, Grassetto e Sottolineato
2.2. Immagini
2.3. Capitoli e Sezioni
2.4. Link
2.5. Blocchi di codice
2.6. Compilare la guida
3. Gestire modifiche e versioni
3.1. Installare Git
3.2. Creare un repository
3.2.1. Il file .gitignore
3.2.2. Attivare il repository
3.2.3. Il primo commit
3.3. Utilizzare il repository
4. Condividere i sorgenti
4.1. Creare un repository su GitHub
4.2. Sincronizzare i repository
4.2.1. Pull del repository remoto
4.2.2. Push del repository locale
4.3. Mantenere sincronizzati i repository
4.3.1. Da locale a remoto
4.3.2. Da remoto a locale
4.4. I file di servizio
4.4.1. README.md
4.4.2. LICENSE.txt
5. Pubblicare la guida
5.1. Il sito per la documentazione del progetto
5.2. Aggiungere i download di altre versioni
5.3. Automatizzare il processo
6. Bibliografia
6.1. ReStructuredText
6.2. Git
6.3. GitHub
6.4. Licenze
7. Ringraziamenti
8. Download sorgenti e binari
8.1. Versioni compilate
8.2. Sorgenti
9. Note legali
9.1. Garanzia
9.2. Riconoscimenti della proprietà
9.3. Accordi di Copyright e Licenza