ne tür bir çevrimiçi teknik dokümantasyon sistemi önerirsiniz? [kapalı]

amaç, aşağıdaki temel gereksinimlere sahip bir çevrimiçi dokümantasyon sistemine sahip olmaktır:

esas olarak tüm başvurumuzun nihai teknik dokümanları için bir ara aşama olarak kullanılacaktır (muhtemelen asla tamamlanmayacaktır:]). Genellikle şu şekilde kullanılır: birisinin bir sorunu var, düzeltiyorum ve düzeltmeyi hemen yazıyorum. Şimdi olan şey yönetilemez hale geliyor: birisinin bir sorunu var, düzeltiyorum, hem ben hem de birileri mutlu ama 2 ay sonra başka biri aynı sorunu yaşıyor ve kimse düzeltmenin ne olduğunu hatırlamıyor.
her yerden erişilebilir, apache sunucumuzun arkasında çalışır
kullanıcı / grup yönetimi, salt okunur / okuma-yazma / yönetici erişimine izin verme
biçim çok önemli değil: düz metin yapardı, wiki stili daha güzel olurdu
ucuz veya ücretsiz

bazı fikirlerim:

dosya paylaşımında veya ssh aracılığıyla dosya sunma (eksileri: windows ile çok fazla kopyalanamaz, artıları: basit, herhangi bir dosya türü olabilir)
bir SCM'de saklayın (svn / git, yukarıdaki gibi idem ancak erişimi ve erişimi kontrol etmek daha kolay)
Confluence: Biz zaten Jira kullanıyoruz, Confluence buna değer mi? Jira ile nasıl bütünleşir?
başka bir şey?

Lütfen bunlar hakkında yorum yapmaktan çekinmeyin veya deneyiminizi diğer sistemlerle paylaşın.

documentation

— stijn
kaynak

Dokümanlar koddan mı üretiliyor (Javadocs gibi) mi yoksa sıfırdan mı, bir kullanıcı kılavuzu olarak mı, yoksa ikisinin bir kombinasyonundan mı yazılıyor?

— Sinirli

daha çok bir kullanım kılavuzundan daha fazlasıdır, kod belgelerini değil (iyi, doxygen tarafından da üretildik, bunu

— ekleyebiliriz

Spolsky'ye biraz nakit verirdim.

— İş

Bir Wiki önerecektim

Confluence bir wiki olduğundan JIRA'nızla kullanmak mükemmel bir fikirdir. JIRA konularına doğrudan bağlanabilme avantajınız olacak ve bu nedenle gerçek kod / doc / yapılan herhangi bir değişiklik vb.

Bunun gibi herhangi bir kod belgesinin anahtarı gezinme yönüdür. Bağlantısı kesilmiş, bulunması zor vb. Sayfaları istemezsiniz. Bir web sitesi için yaptığınız gibi bir 'site düzenini' düşünün.

— Martijn Verburg
kaynak

Confluence görünüşte çeşitli düz formatlarda dışa aktarabilir. Kolayca düzenlenebilirden bitmiş üretime geçmenin en kolay yollarından biri gibi görünüyor. T

Çalıştığım yerde Confluence var - MediaWiki'den göç ettik - ve çeşitli biçimlere (Word en popüler olanı) çıktı olarak iyi bir iş çıkarıyor. Ancak WYSIWYG düzenleme araçlarının inanılmaz derecede hatalı olduğu ve etiketleme sisteminin en azından kurulumumuzda arzulanan çok şey bıraktığı konusunda uyarılmalıdır.

— Philip Regan

Wiki için +1, Trac'i de dosya paylaşımına izin veren SVN ile entegre olduğu için çok yararlı buldum.

Bir Confluence denemesini kontrol ettik ve çözüm bu olacak. İhtiyacımız olandan daha fazlasını yapabiliyor gibi görünüyor, ancak çalışmak oldukça kolay.

— Trac'yi