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

11

l'obiettivo è avere un sistema di documentazione online, con questi requisiti principali:

  • sarà utilizzato principalmente come fase intermedia per i documenti tecnici finali di tutte le nostre applicazioni (che probabilmente non saranno mai completati però:]). Normalmente viene usato in questo modo: qualcuno ha un problema, lo aggiusto e annoto la correzione immediatamente. Quello che succede ora è diventato ingestibile: qualcuno ha un problema, io lo aggiusto, io e 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 utenti / gruppi, che consente l'accesso di sola lettura / lettura-scrittura / amministratore
  • il formato non è troppo importante: il testo normale lo farebbe, lo stile wiki sarebbe più bello se
  • economico o gratuito

alcune mie idee:

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

Non esitare a commentarli oa condividere la tua esperienza con altri sistemi.

    
posta stijn 20.01.2011 - 12:08
fonte

1 risposta

11

Stavo per suggerire un Wiki

Poiché Confluence è una wiki, penso che utilizzarla con la tua JIRA sia un'idea eccellente. Avrai il vantaggio di essere in grado di collegarti direttamente ai problemi di JIRA e quindi al codice / doc / qualsiasi modifica apportata ecc.

La chiave per qualsiasi repository di documenti in codice come questo è l'aspetto della navigazione. Non vuoi che le pagine siano disconnesse, difficili da trovare, ecc. Metti in pratica il "layout del sito" come faresti per un sito web.

    
risposta data 20.01.2011 - 12:15
fonte

Leggi altre domande sui tag