Alla ricerca di un pacchetto di documentazione in stile wiki, standalone, version-control- "sicuro"

Question

Il mio team e io abbiamo scoperto che documentare il nostro progetto (una piattaforma di sviluppo con API) con un wiki è sia utile che utile per gli utenti. A causa di alcuni problemi organizzativi, siamo costretti a fare lo sviluppo di più siti senza la connettività di rete. Siamo passati a un DVCS (Mercurial) e abbiamo avuto un grande successo con questo. La documentazione wiki si rivela un problema in quanto il sito centrale viene configurato con MediaWiki. Le persone fuori sede non hanno modo di accedere o modificare il wiki.

Esiste qualche tipo di pacchetto in stile wiki che non richiede un server/database e sarà utilizzabile in un ambiente DVCS?

Aggiornamento: Dovrebbe essere open-source e cross-platform

Answer 1

Finito di scrivere il mio sistema usando python, cherrpy e mercurial. Forse un giorno finirà con l'open-source. Grazie per tutti i suggerimenti.

Answer 2

DokuWiki memorizza tutti i dati in file di testo. È possibile installare server Web locali per ogni sviluppatore e utilizzare il proprio sistema VC per la sincronizzazione tra gli sviluppatori.

Answer 3

Posso consigliare TiddlyWiki. Non ha bisogno di alcun server web, solo un browser, archivia l'intera documentazione Wiki in una singola pagina HTML. Questo può essere facilmente condiviso attraverso Mercurial.

Modifica:Check this page, viene illustrato come utilizzare TiddlyWiki con DVCS. Implica l'uso di un'estensione denominata SynchroTiddly.

Answer 4

Forse dovresti guardare auto-generation of documentation dalla fonte. In questo modo, la documentazione sarà automaticamente controllata dalla versione.

Molti generatori supportano l'aggiunta di documentazione aggiuntiva tramite file di testo semplice che possono essere aggiunti al repository.

Answer 5

ikiwiki: http://ikiwiki.info/ memorizza le informazioni direttamente nel VCS (supporta mercurial come backend).

Answer 6

Cerca in Fossil è un DVCS che contiene un wiki integrato e un sistema di tracciamento dei bug. Questo potrebbe essere proprio quello che stai cercando. Leggi il sito, c'è un webserver integrato. Puoi usare uno script CGI per aprire la connessione alle persone (il sito fossile è il DVCS fossile). Dopo averlo utilizzato, potresti decidere di spostare anche il tuo codice. È open source e ha build multipiattaforma.

Answer 7

http://zim-wiki.org/
È una wiki desktop (modifica WYSIWYG, sebbene non molto sofisticata) che memorizza tutto in file di testo semplice. Ciò significa che puoi tenere i file nel controllo di versione, e avere un'esperienza di modifica amichevole.

Ha anche builtin Bazaar support AGGIORNAMENTO: anche Git, Mercurial e Fossil.

^{[lo so, in ritardo alla festa - scrittura per il beneficio di altri che leggono questa domanda ...]}

Answer 8

http://hatta-wiki.org/ è un wiki in esecuzione su un repository Mercurial.

È interessante notare come gestisce i conflitti: le modifiche simultanee vengono silenziosamente unite al commit, anche se in conflitto e commesso con i marcatori di conflitto!Va bene perché:

• è testo, non il software
• si vede il risultato della tua modifica subito dopo commettere
• si tratta di marcatori di conflitto come la sintassi wiki valido (con conseguente diff -u come mettendo in evidenza del conflitto)!

Questa disposizione ti motiva a modificare nuovamente per risolvere immediatamente il conflitto, ma non ti obbliga a farlo.

Answer 9

MoinMoin supporta la memorizzazione delle pagine in un repository Mercurial: http://moinmo.in/Storage2009/HelpOnStorageConfiguration#Mercurial_Backend_.28hg.29

Questo è molto interessante perché MoinMoin è stato intorno per un po ', è piuttosto ben supportato, e un ricco set di funzionalità (ma questa è solo la mia opinione; non fidarti della mia parola e vederla da sola ;-)).

Answer 10

Github's gollum è open-source, basato su git, mangia molte sintassi popolari. Ma il punto di forza più importante è che è incorporato nel github.

Bitbucket allo stesso modo has un wiki basato mercurial. Non sono sicuro che il codice sia open source (ad esempio, puoi modificare il testo offline, ma non essere sicuro di vederlo visualizzato).

Answer 11

Se è necessaria una grande piattaforma open source per la gestione della conoscenza che possa includere oggetti di conoscenza basati su video, wiki, flusso di lavoro e una serie di servizi Web di community collaborativi, controlla RuleSphere.com. Stanno lavorando su alcuni KM interessanti e componenti wiki e video.

Ci hanno aiutato a comprendere i vantaggi di lavorare con una piattaforma aperta, piuttosto che una wiki autonoma, al fine di avere una strategia a lungo termine per estendere dalla gestione della conoscenza a molte altre esigenze che la nostra piccola impresa vuole indirizzare successivamente anno. Ora siamo entusiasti di aver selezionato una piattaforma di community collaborativa con cui possiamo crescere.

In conclusione: ci sono oltre 100 piattaforme wiki stand-alone, ma i loro limiti superano di gran lunga le funzionalità di estensibilità e integrazione. Assicurati di avere la vista "immagine grande" e di mantenere una mente aperta per una piattaforma open source progettata per i servizi Web 2.0, la tecnologia reattiva e la collaborazione. Sarai felice di averlo fatto!