Strumento simile a Wiki per la scrittura di specifiche e documentazione [chiuso]


9

Sto cercando un wiki o un sistema simile a wiki per scrivere e gestire specifiche e documentazione per un progetto software.

So che ci sono molte implementazioni wiki disponibili, ma ce ne sono alcune particolarmente adatte a questo tipo di attività?

In realtà non deve essere un wiki, solo un sistema che semplifica la scrittura e la navigazione di specifiche e documentazione e che supporta la traccia delle modifiche.


1
Stai usando una piattaforma speciale? Come ad esempio il TFS di Microsoft?
Saeed Neamati,

Sulla base di quanto richiesto da @Saeed, che tipo di infrastruttura ha già messo in atto il tuo team / organizzazione per la gestione e la condivisione delle conoscenze? Inoltre, quali sono i tuoi processi attuali per scrivere specifiche e documenti?
Thomas Owens

Risposte:


6

Stiamo usando LaTeX e SVN. Poiché i documenti LaTeX sono solo file di testo, funziona bene con il controllo della versione, a differenza di alcuni formati binari o parzialmente binari.

Ottieni tutti i vantaggi (e gli svantaggi, certamente) del controllo di versione a cui sei abituato a usarlo con il tuo codice.

LaTeX richiede un po 'di configurazione (per definire i tuoi stili / classe), ma una volta che lo hai fatto è molto buono - puoi concentrarti solo sul contenuto piuttosto che sulla sua presentazione (piuttosto che essere tentato di modificare costantemente come sei con WYSIWYG), ma alla fine ottieni ancora un documento PDF elegante e dall'aspetto professionale.


4

Personalmente, mi piace molto Tiddly Wiki .

Ha una sintassi wiki abbastanza completa, è un singolo file html autonomo e funziona bene con una varietà di browser Web senza la necessità di un server.

Ha anche un'architettura plug-in estensibile che ti consente di aggiungere plugin per fare ogni sorta di cose interessanti come crittografare i tiddler o aggiungere note a piè di pagina.


3

Per la piattaforma Microsoft, l'integrazione TFS (Team Foundation Server) con SharePoint è proprio ciò che stai cercando. Creando un nuovo progetto di gruppo, è possibile scegliere un modello che comprenda quasi tutti gli aspetti del processo di sviluppo del software. Ti offre un portale in cui puoi definire i membri del team, assegnare ruoli e autorizzazioni di sicurezza, caricare, condividere e modificare documenti e specifiche relativi al tuo progetto e fare molte altre cose interessanti con esso.

Per altre piattaforme, penso che tu possa usare qualcosa come GitHub (anche se non ne sono sicuro).



0

Potresti provare Sphinx , con i documenti registrati nella tua infrastruttura di gestione del controllo del codice sorgente prescelta. Ciò presenta i vantaggi del controllo del codice sorgente e di un linguaggio di markup relativamente leggero, reStructuredText , facile da imparare e abbastanza ben strutturato per le conversioni (in HTML, in PDF e così via).

Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.