salve a tutti,
da un po' di tempo stavo pensado al miglior modo per scrivere documentazione per un programma. ho pensato alla documentazione on-line e mi è venuta in mente una wiki, ma potrei anche avere la necessità di disporre di questa documentazione in PDF. preferisco il modello wiki perché contine delle caratteristiche come l'indice e il motore di ricerca che possono essere molto utili.
esiste un modo per "estrarre" le informazioni da un wiki e farci un libro in PDF?
poi ho notato che molta documentazione è organizzata in questo modo
http://www.pluto.it/files/ildp/guide/Gu ... index.html
l'indice nella prima pagine e poi dei collegamenti "avanti" "indietro" ai margini della pagina. poi la stessa documentazione è proposta in formato PDF, HTML unico [ecc..ecc..]
si usa LATEX per questo tipo di cose?
grazie e ciao
Infrid
edit---
mi sa che ho sbagliato sezione, meglio OFF-TOPIC?
Scrivere documentazione nel miglior modo
Moderatore: Staff
Regole del forum
1) Citare sempre la versione di Slackware usata, la versione del Kernel e magari anche la versione della libreria coinvolta. Questi dati aiutano le persone che possono rispondere.
2) Per evitare confusione prego inserire in questo forum solo topic che riguardano appunto Gnu/Linux in genere, se l'argomento è specifico alla Slackware usate uno dei forum Slackware o Slackware64.
3) Leggere attentamente le risposte ricevute
4) Scrivere i messaggi con il colore di default, evitare altri colori.
5) Scrivere in Italiano o in Inglese, se possibile grammaticalmente corretto, evitate stili di scrittura poco chiari, quindi nessuna abbreviazione tipo telegramma o scrittura stile SMS o CHAT.
6) Appena registrati è consigliato presentarsi nel forum dedicato.
La non osservanza delle regole porta a provvedimenti di vari tipo da parte dello staff, in particolare la non osservanza della regola 5 porta alla cancellazione del post e alla segnalazione dell'utente. In caso di recidività l'utente rischia il ban temporaneo.
1) Citare sempre la versione di Slackware usata, la versione del Kernel e magari anche la versione della libreria coinvolta. Questi dati aiutano le persone che possono rispondere.
2) Per evitare confusione prego inserire in questo forum solo topic che riguardano appunto Gnu/Linux in genere, se l'argomento è specifico alla Slackware usate uno dei forum Slackware o Slackware64.
3) Leggere attentamente le risposte ricevute
4) Scrivere i messaggi con il colore di default, evitare altri colori.
5) Scrivere in Italiano o in Inglese, se possibile grammaticalmente corretto, evitate stili di scrittura poco chiari, quindi nessuna abbreviazione tipo telegramma o scrittura stile SMS o CHAT.
6) Appena registrati è consigliato presentarsi nel forum dedicato.
La non osservanza delle regole porta a provvedimenti di vari tipo da parte dello staff, in particolare la non osservanza della regola 5 porta alla cancellazione del post e alla segnalazione dell'utente. In caso di recidività l'utente rischia il ban temporaneo.
-
masalapianta
- Iper Master
- Messaggi: 2775
- Iscritto il: lun 25 lug 2005, 0:00
- Nome Cognome: famoso porco
- Kernel: uname -r
- Desktop: awesome
- Distribuzione: Debian
- Località: Roma
- Contatta:
per scrivere mini guide e cosette piccole, puoi usare anche direttamente wiki (anche se non e' esattamente un formato in cui scrivere documentazione ma uno in cui presentarla con un particolare strumento); per tutto il resto c'e' latex e sgml (personalmente uso sgml con linuxdoc come DTD ma va benissimo anche latex).