che tipo di sistema di documentazione tecnica online consiglieresti? [chiuso]

l'obiettivo è disporre di un sistema di documentazione online, con i seguenti requisiti principali:

sarà utilizzato principalmente come fase intermedia per la documentazione tecnica finale di tutta la nostra applicazione (che probabilmente non verrà mai completata però:]). In genere viene utilizzato come tale: qualcuno ha un problema, lo risolvo e scrivo la correzione immediatamente. Quello che succede ora sta diventando ingestibile: qualcuno ha un problema, lo risolvo, sia io che qualcuno siamo felici, ma 2 mesi dopo qualcun altro ha lo stesso problema e nessuno ricorda quale fosse la soluzione.
accessibile da qualsiasi luogo, in esecuzione dietro il nostro server Apache
gestione utente / gruppo, che consente l'accesso in sola lettura / lettura-scrittura / admin
il formato non è troppo importante: il testo normale farebbe, tuttavia lo stile wiki sarebbe più bello
economico o gratuito

alcune mie idee:

serve solo file su una condivisione di file o tramite ssh (contro: non troppo copmatibile con Windows, pro: semplice, può essere di qualsiasi tipo)
tenerlo in un SCM (svn / git, idem come sopra ma più facile accedere e controllare l'accesso)
Confluenza: usiamo già Jira, ne vale la pena? Come si integra con Jira?
qualcos'altro?

Non esitate a commentare questi o condividere la vostra esperienza con altri sistemi.

documentation

— Stijn
fonte

La documentazione viene generata dal codice (come Javadocs) o viene scritta da zero, come una guida dell'utente o una combinazione delle due?

— FrustratedWithFormsDesigner

è principalmente più di una guida per l'utente, non di documentazione del codice (beh, abbiamo anche quello, generato da doxygen, potremmo includerlo, ma non è il primo punto di interesse)

— stijn

Vorrei consegnare un po 'di denaro a Spolsky.

— Giobbe

Stavo per suggerire un Wiki

Dato che Confluence è un wiki, penso che usarlo con il tuo JIRA sia un'idea eccellente. Avrai il vantaggio di essere in grado di ricollegare direttamente ai problemi di JIRA e quindi il codice / documento / qualsiasi modifica effettuata ecc.

La chiave per qualsiasi repository di documenti di codice come questo è l'aspetto della navigazione. Non vuoi pagine disconnesse, difficili da trovare, ecc. Pensa a un "layout del sito" come faresti per un sito web.

— Martijn Verburg
fonte

Apparentemente la confluenza può esportare in vari formati piatti. Sembra uno dei modi più semplici per passare dal produc.t facilmente modificabile al prodotto finito

Abbiamo Confluenza dove lavoro - siamo migrati da MediaWiki - e fa un buon lavoro in molti formati (Word è il più popolare). Ma attenzione: i suoi strumenti di editing WYSIWYG sono incredibilmente difettosi e il sistema di tagging lascia molto a desiderare, almeno sulla nostra installazione.

— Philip Regan,

+1 per Wiki, ho trovato anche Trac molto utile in quel caso in quanto si integra con SVN consentendo anche la condivisione di file.

abbiamo verificato una versione di prova di Confluence e sarà la soluzione. Sembra essere in grado di fare molto più del necessario, ma è abbastanza facile lavorare con. Ho provato Trac un paio di anni fa ed era un po 'troppo disordinato per i miei gusti, specialmente quando si trattava di plugin ecc.

— Stijn