Software per organizzare e mantenere la documentazione del progetto, le specifiche? [chiuso]

Sto cercando un software per organizzare e mantenere la documentazione interna dei progetti, le specifiche, i requisiti, ecc. Attualmente archiviamo tutta la documentazione come molti file DOC di MS Word in un repository di controllo del codice sorgente, che ci dà il controllo della versione, e questo è carino. Ma non puoi cercare queste informazioni, creare collegamenti tra loro, categorizzare, collaborare.

Requisiti, preferenze:

• Zero installazione sul lato client (basata su WEB).
• Controllo della versione del documento.
• Annotazioni del documento.
• Collegamento del documento.
• Ricerca completa (tutta la documentazione).
• MS Word (* .doc) import \ export.
• Editor di testo WYSIWYG.

Sistemi che ho scoperto e provato finora:

• MediaWiki
• XWiki
• Confluenza

Che ne dici di qualcosa come la Sfinge ?

Scrivi la tua documentazione in reStructuredText (la sintassi è simile a Markdown, che Stack Overflow utilizza) in file di testo (= controllo facile da versione) e Sphinx sputa pagine HTML.

I due utenti Sphinx più importanti (che conosco) sono il linguaggio Python e TortoiseHG (vedere i collegamenti per la documentazione generata da Sphinx).

MODIFICARE:

Ho appena letto che stai parlando della documentazione interna al progetto, non della documentazione per l'utente finale.
A mio avviso, qualcosa come Sphinx è il modo migliore anche per la documentazione interna (a condizione che tu possa convincere i tuoi analisti a scrivere reStructuredText) perché:

1. Puoi facilmente controllare la versione dei documenti (e le differenze tra i file di testo occupano molto, molto meno spazio rispetto ai file binari come .doc o .pdf).
2. Se uno sviluppatore desidera un file .doc o .pdf leggibile, può crearlo con Sphinx dai sorgenti.

Se Sphinx è troppo complicato, c'è anche un modo più semplice: puoi scrivere la tua documentazione in Markdown e usare Pandoc per creare (ad esempio) file .rtf, .doc o .pdf (può fare molto di più).
Ho trovato Pandoc più facile da iniziare rispetto a Sphinx, ma Pandoc non è in grado di creare belle gerarchie di menu come Sphinx (come nella documentazione di Python e TortoiseHG che ho collegato sopra).

Indipendentemente dagli strumenti utilizzati, se si dispone di un server Web interno e di un server di compilazione, è possibile configurarlo in modo che il server di generazione generi output HTML e lo copi sul server Web ogni volta che qualcuno invia qualcosa alla documentazione. Quindi i tuoi analisti non devono nemmeno pensare all'output finale, devono solo impegnarsi e spingere i loro cambiamenti.

Bene, puoi provare a implementare un Wiki. Mediawiki ha tutte le caratteristiche mancanti di cui stai parlando (funzioni di ricerca, cronologia delle versioni, collegamenti, categorizzazione). Dovrai assicurarti di sapere esattamente quale versione della documentazione appartiene a quale versione del software, ma ciò può essere fatto per convenzione includendo un riferimento alla versione o una categoria specifica in ogni articolo dipendente dalla versione.

MA: scrivi di avere "analisti" che non sono sviluppatori (lo ammetto, non sono un fan di quella costellazione). Quel tipo di persone spesso non è contento quando si sostituiscono gli strumenti di MS Office con alcuni strumenti testuali come un Wiki. E poiché MS-Word non è un software libero, quindi immagino che il requisito "software libero" non sia davvero un must. In questa situazione, un server Sharepoint potrebbe essere la migliore alternativa. Non gratuito, ma AFAIK ha tutte le funzionalità che stai richiedendo e i documenti possono ancora essere creati usando Word, Excel ecc.

È sempre meglio mantenere le specifiche e la documentazione sotto controllo della versione in quanto ti darebbe la leva maggiore anche se la curva di apprendimento sarebbe un po 'ripida. Nel caso di un motore di conoscenza, raccomando quanto segue

1. Trac - Sistema di tracciamento dei bug e motore di conoscenza facili da usare. Scritto in Python ed estensibile, saresti attivo e funzionante in pochi minuti
2. MoinMoin - Motore wiki completo. Ancora una volta Python con molte funzionalità

Entrambi hanno interfacce minime, supporta la maggior parte delle strutture wiki, abbastanza facili da implementare e mantenere, supportare le revisioni, ha un buon editor WYSIWYG e puoi anche conservare la tua documentazione e le tue specifiche. A meno che i tuoi progetti non siano davvero enormi, puoi scegliere uno dei precedenti.

Di recente abbiamo iniziato a utilizzare Alfresco DMS che ha molte proprietà interessanti:

• Installazione molto semplice
• Ha un indicizzatore integrato per la ricerca rapida tra un sacco di documenti
• Consente flussi di lavoro, gruppi e, se necessario, accesso specifico ai documenti da parte dei clienti
• Open-source
• Comunità attiva
• Integrazione LDAP / AD / SSO
• Gestisce molti documenti diversi

Ci sono anche alcuni svantaggi:

• L'interfaccia utente non è sempre intuitiva
• Non è proprio un wiki, quindi il lavoro collaborativo simultaneo su un documento potrebbe essere un po 'fragile

Se decidi di fare un salto, per favore contattami con le tue opinioni.

Un'altra possibilità potrebbe essere quella di utilizzare LaTeX o qualche altro formattatore di testo (forse texinfo o addirittura lout ) per la documentazione. Parti di esso possono essere generate a macchina. Esistono alcuni strumenti per la conversione HTML, come HeVeA per convertire LaTeX in HTML. Puoi anche usare doxygen per generare documentazione da commenti strutturati all'interno del tuo codice sorgente. E le parti della documentazione scritte a mano possono (e dovrebbero) essere gestite come codice sorgente (ad esempio controllo e build della versione).

Suggerirei di utilizzare uno strumento UML ed ERD, oltre ai tuoi documenti. Inoltre, è possibile archiviare questi documenti su ZOHO su ZOHO-Docs , che non è gratuito, ma è estremamente economico e consente la ricerca di documenti.

Qualunque sia lo strumento che si utilizza, è necessario organizzare attentamente i contenuti del documento per poter utilizzare la ricerca di testo e ottenere risultati significativi. L'organizzazione del contenuto dei documenti insieme alla denominazione dei file intelligente e standard potrebbe essere di grande aiuto.