Flusso di lavoro per trasformare il contenuto Wiki in un manuale di sistema
Domanda
Siamo nel mezzo dell'implementazione di un nuovo sistema software per molti utenti in molti posti (oltre 200 utenti in 8 paesi). In passato abbiamo scritto un manuale per gli utenti, quindi lo aggiorniamo ogni tanto. Funziona bene, in quanto tutti gli utenti hanno lo stesso manuale e coprono le cose principali ma hanno i loro problemi, come se non si aggiornassero spesso, a volte perdiamo gli aggiornamenti e alcuni utenti avranno vecchie copie.
Abbiamo parlato dell'utilizzo di un wiki durante le fasi di test e distribuzione per creare una base di conoscenza sul sistema. Idealmente vorremmo quindi un modo per convertirlo in una forma di documento elettronico che potremmo quindi "cercare" e inviare come manuale ufficiale, oltre a consentire agli utenti di utilizzare e aggiornare il wiki.
Qualcun altro ha fatto qualcosa di simile? Qualche suggerimento per sistemi wiki, flussi di lavoro, formati di documenti, ecc?
Soluzione
La maggior parte dei wiki supporta l'esportazione tramite PDF, ad esempio:
Altri suggerimenti
Puoi scrivere qualcosa che genera LaTeX dal wiki e rende un manuale in PDF. Con pacchetti come hyperref puoi conservare i riferimenti incrociati come hyperlink.
Inoltre, è possibile integrare contenuti da più fonti come un dizionario di dati nel documento LaTeX, che può essere mischiato e abbinato al contenuto del wiki. È inoltre possibile configurare l'architettura in modo che supporti il ??riferimento incrociato che va in entrambi i modi.
Framemaker potrebbe anche supportare questo utilizzando MIF e puoi anche usare Lout in modo simile o converti il ??contenuto del tuo wiki in docbook, che ti consentirebbe di utilizzare una delle molte opzioni di rendering disponibili in quel formato.
A parte questo, i seguenti post su Stackoverflow parlano di vari sistemi per conservare la documentazione.
-
Applicazione (non un linguaggio di markup ) per la produzione di un manuale utente
-
Può essere usato LaTeX per la produzione di documentazione che accompagna il software?
-
Quali strumenti vengono utilizzati per scrivere la documentazione?
-
Quali strumenti utilizza il tuo team per la scrittura di manuali utente?
-
I migliori strumenti per lavorare con DocBook XML documenti?
-
Qual è la toolchain consigliata per la formattazione di XML DocBook?
Madcap Flare è uno strumento di authoring manuale che utilizza HTML per fonte di ogni argomento. Si potrebbe facilmente fare un'importazione di massa delle pagine Wiki. Richiederebbe quindi un po 'di pulizia, ma in seguito hai un bel sistema a sorgente singola in grado di generare CHM, aiuto navigabile, PDF, DOC / DOCX, ecc.
Come stai memorizzando la fonte di aiuto al momento? Sono file MS Word, aiuto di MS, LaTeX?
Se metti i tuoi file sorgente della guida sotto il controllo della versione, otterrai tutti i vantaggi di una wiki senza dover migrare a un nuovo sistema - le persone possono apportare facilmente modifiche ai file della guida - tali modifiche possono essere monitorate, ripristinate, ecc. e ottieni i manuali predefiniti come prima.
Ho seguito i collegamenti di Node e mi sono imbattuto in alcune pagine di mediawiki che ritenevo degne di nota.
Ho dato una risposta precedente che può essere utile per " wiki in PDF " parte - guarda usando il codice o la funzionalità PediaPress open source. Puoi ottenere anche ODF da esso, anche se i loro PDF sono già abbastanza carini (ma potresti voler rinominarlo e ridisegnarlo per la tua azienda, suppongo).