Quale sistema wiki / documentario consigliate per la gestione della conoscenza? [chiuso]

Question

Quale sistema wiki / documentario consigliate per la gestione della conoscenza? [chiuso]

#1 da (3 voti)
#2 da (2 voti)
#3 da (0 voti)

4

Sono il fondatore di un sito web chiamato Now.in. All'inizio ho scritto tutti i programmi da solo. E gestiremo una start-up. Altre persone saranno presto coinvolte. Nella mia mente esistono solo alcuni know-how / panoramiche, ci vuole del tempo per spiegare ai nuovi arrivati. Quindi, vorrei scrivere alcuni documenti che altri possano leggere. Ecco il problema, come scrivere documenti? Quale strumento / piattaforma dovrei usare?

Ho qualche dubbio.

Portabilità

Di sicuro posso solo scrivere documenti in Google Docs, eseguire un Wiki, o anche usare wiki del repository BitBucket direttamente. Ma il problema è, cosa succede se mi piacerebbe utilizzare un altro sistema di documenti piuttosto che quello attuale? Sarebbe difficile e costoso convertire documenti tra lingue di markdown / Google Documenti.

Facile da usare

I diagrammi sono importanti nei documenti per spiegare le cose. Alcuni dei semplici sistemi wiki / doc non supportano il caricamento di immagini. Puoi caricare l'immagine da qualche altra parte e inserire il tag immagine nei documenti, il che è piuttosto scomodo da usare.

Inoltre, sembra che alcuni di questi linguaggi di markdown siano difficili da imparare e ricordare. Non mi piace passare un mese per imparare qualcosa che assomiglia a LaTeX e iniziare a scrivere un documento, che mi farà impazzire. Markdown semplice ed espressivo / WYSIWYG sarebbe bello.

Espressione di codice

Google Doc è facile da usare e abbastanza potente. Tuttavia, a volte vorrei scrivere esempi di codice nei documenti. È bene avere l'evidenziazione della sintassi. Ma Google Doc non è facile da usare per la scrittura del codice.

Essendo un codice amichevole, sarebbe anche una bella funzionalità.

Integrazione con documenti API

Per documenti di panoramica / SOP / Know-how, è bene scriverli direttamente nel sistema di documenti. Ma per la mia base di codice Python, potrebbero esserci alcuni documenti generati a livello API da quei codici. Sarebbe scomodo avere due sistemi di documenti, uno per l'API e uno per le panoramiche. Quindi, penso che sarebbe bello averli integrati insieme.

Quindi .... Che cosa usare?

Forse ho qualche dubbio in più nella mia mente, ma non riesco a ricordarli in questo momento. Mi piacerebbe sapere che tipo di sistema di documenti stai usando? Potresti raccomandarne qualcuno? Va bene anche se ci vuole un po 'di soldi per usare la piattaforma / sistema, possiamo permetterci se non è troppo costoso.

documentation knowledge-management wiki

posta Fang-Pen Lin 31.07.2011 - 09:56

fonte

3 risposte

3

Sono totalmente d'accordo con Simon Stelling sui suoi punti . Trac è un ottimo strumento che ho utilizzato più volte per avere quasi ogni aspetto di un progetto in una posizione centralizzata. Tuttavia, ci sono altri strumenti là fuori.

Un altro strumento che puoi considerare sarebbe Redmine . Per alcune delle funzionalità che desideri (come la portabilità), dovrai personalizzarlo con i plugin. Non ho esperienza significativa con Redmine, dato che l'ho usato solo una volta, ma ho pensato che fosse abbastanza stabile e affidabile, e ha svolto il lavoro in termini di affidamento di liste di cose da fare, documentazione, segnalazioni di errori, e così via.

Ancora una volta, Redmine è stato creato per essere un punto di riferimento per le informazioni sul progetto, che vanno dalla pianificazione / al tracciamento delle attività fino al codice sorgente e alla documentazione. Questo potrebbe essere un po 'eccessivo, ma mi piace avere strumenti come questo a mia disposizione.

risposta data 31.07.2011 - 14:12

fonte

0

Ho suggerito WordPress nella mia risposta al link .
Trac non è in realtà un sistema di gestione della base di conoscenza, ma un sistema di tracciamento dei problemi.
- Ne avrai comunque bisogno, non è un'alternativa a un KB.
- Ricorda che in un sistema di tracciamento è importante vedere nel tempo che cosa è cambiato in un progetto dove, mentre in un sistema di knowledge base è importante vedere ciò che è attuale e come funziona, plus assolutamente qualsiasi cosa tu possa pensare che sia importante per un progetto e per una società .

risposta data 31.07.2011 - 14:09

fonte

Leggi altre domande sui tag documentation knowledge-management wiki

Che cos'è uno schema di scrittura bufferizzato? I team di sviluppo software LAMP / basati su Java hanno SOE?

score 2 · Accepted Answer

Posso consigliare Trac .

Per quanto riguarda i tuoi requisiti:

Portabilità: La sintassi utilizzata è abbastanza standard e esistono strumenti per esportare gli articoli del wiki.
Facile da usare: il sistema è molto intuitivo da usare. Le immagini sono supportate, la sintassi è facile da ricordare e si sente naturale. Esiste una modalità WYSIWYG in cui viene visualizzato il contenuto formattato mentre digiti il contrassegno come in StackExchange.
Espressioni di codice: Orientato verso i programmatori, Trac supporta in modo nativo i blocchi di codice inline che sono evidenziati automaticamente dalla sintassi.
Integrazione con documenti API: non so se esiste un modulo specifico che consente di integrare strettamente la documentazione e la panoramica dell'API. Tuttavia, esistono le seguenti possibilità:
- Definisci i tuoi tipi di URL, ad es. [pydoc:Class/Method] che viene quindi mappato a qualsiasi URL utilizzato da pydoc.
- Trova un modulo esistente su TrackHacks .
- Scrivi il tuo modulo. Ciò richiede meno tempo di quanto probabilmente pensi.
Altre preoccupazioni: Trac è una piattaforma estremamente semplice da estendere. Se ti capita di trovare ulteriori requisiti in futuro, non ti costerà molto integrare questa funzionalità in Trac anche se non esiste ancora. È anche facilmente personalizzabile, cioè puoi adattarlo alle tue esigenze specifiche. Ad esempio, se non hai bisogno del modulo di repository di codice, puoi semplicemente scaricarlo.