Proje belgelerini düzenlemek ve korumak için yazılım, şartname? [kapalı]

Projelerin dahili belgelerini, özelliklerini, gereksinimlerini vb. Düzenlemek ve sürdürmek için yazılım arıyorum. Şu anda tüm belgeleri bir sürü MS Word DOC dosyası olarak bir kaynak kontrolü deposunda saklıyoruz, bu da bize sürüm kontrolü sağlıyor ve bu güzel. Ancak bu bilgileri arayamaz, aralarında bağlantı oluşturamaz, kategorilere ayıramaz, işbirliği yapamazsınız.

Gereksinimler, Tercihler:

• İstemci tarafında sıfır kurulum (WEB tabanlı).
• Belge sürümü kontrolü.
• Belge açıklamaları.
• Belge bağlama.
• Tam arama (tüm belgeler).
• MS Word (* .doc) import \ export.
• WYSIWYG metin editörü.

Şimdiye kadar keşfettiğim ve denediğim sistemler:

• MediaWiki
• XWiki
• izdiham

Sfenks gibi bir şeye ne dersin ?

Belgelerinizi reStructuredText'te (sözdizimi Stack Overflow'un kullandığı Markdown'a benzer) düz metin dosyalarına (= sürüm kontrolü kolay) yazarsınız ve Sphinx HTML sayfalarını tükürür.

En çok bilinen iki Sphinx kullanıcısı (bildiğim) Python dili ve TortoiseHG'dir (Sphinx tarafından üretilen belgelerin bağlantılarına bakın).

DÜZENLE:

Sadece son kullanıcı belgelerinden değil, proje içi belgelerden bahsettiğinizi okudum.
Bence, Sfenks gibi bir şey dahili dokümantasyon için de en iyi yoldur (analistlerinizin reStructuredText yazmasını sağlayabilirsiniz) çünkü:

1. Belgeleri kolayca kontrol edebilirsiniz (ve metin dosyalarının farklılıkları .doc veya .pdf gibi ikili dosyalardan çok daha az yer kaplar).
2. Bir geliştirici güzel okunabilir bir .doc veya .pdf dosyası isterse, kaynaklardan Sphinx ile oluşturabilir.

Sphinx çok karmaşıksa, daha da kolay bir yol var: belgelerinizi Markdown'a yazabilir ve Pandoc'u kullanarak (örneğin) .rtf, .doc veya .pdf dosyaları oluşturabilirsiniz (çok daha fazlasını yapabilir).
Pandoc'u Sphinx'e başlamaktan daha kolay buldum, ancak Pandoc, Sphinx gibi güzel menü hiyerarşileri oluşturamıyor (yukarıda bağladığım Python ve TortoiseHG belgelerinde olduğu gibi).

Hangi araçları kullanırsanız kullanın, dahili bir web sunucunuz ve bir yapı sunucunuz varsa, yapı sunucusu HTML çıktısı oluşturacak ve birisi belgelere her girdiğinde bunu web sunucusuna kopyalayacak şekilde ayarlayabilirsiniz. Bu nedenle analistlerinizin nihai çıktıyı düşünmesi bile gerekmiyor, sadece değişikliklerini taahhüt etmeleri gerekiyor.

Bir Wiki uygulamaya çalışabilirsiniz. Mediawiki, bahsettiğiniz tüm eksik özelliklere sahiptir (arama işlevleri, sürüm oluşturma geçmişi, bağlantılar, kategorizasyon). Belgenin hangi sürümünün yazılımın hangi sürümüne ait olduğunu tam olarak bildiğinizden emin olmanız gerekir, ancak bu, sürüme bağlı her makaleye sürüm referansı veya belirli bir kategori ekleyerek kuralla yapılabilir.

AMA: Sen geliştirici olmayan "analistlerin" olduğunu yazıyorsun (itiraf ediyorum, ben bu takımyıldızın hayranı değilim). MS Office araçlarını bir Wiki gibi metin odaklı bir araçla değiştirdiğinizde bu tür insanlar genellikle mutlu olmazlar. Ve MS-Word özgür yazılım olmadığı için, "özgür yazılım" gereksinimi gerçekten bir zorunluluk değildir sanırım. Bu durumda, bir Sharepoint sunucusu daha iyi bir alternatif olabilir. Ücretsiz değil, ancak AFAIK, istediğiniz tüm özelliklere sahiptir ve Word, Excel vb. Kullanılarak belgeler oluşturulabilir.

Şartname ve dokümantasyonu sürüm kontrolü altında tutmak her zaman daha iyidir, çünkü öğrenme eğrisi biraz dik olsa da size en büyük kaldıracı verecektir. Bir bilgi motoru olması durumunda, aşağıdakileri tavsiye ederim

1. Trac - Kolay hata izleme sistemi ve bilgi motoru. Python ile yazılmış ve genişletilebilir, birkaç dakika içinde çalışmaya başlayacaksınız
2. MoinMoin - Tam teşekküllü wiki motoru. Yine birçok özelliğe sahip Python

Her ikisi de en az arayüze sahip, wiki yapılarının çoğunu destekliyor, kurulumu ve bakımı oldukça kolay, revizyonları destekliyor, iyi bir WYSIWYG editörüne sahip ve hatta belgelerinizi ve spesifikasyonlarınızı da saklayabilirsiniz. Projeleriniz gerçekten büyük olmadıkça, yukarıdakilerden herhangi birini seçebilirsiniz.

Son zamanlarda birçok ilginç özelliğe sahip Alfresco DMS'yi kullanmaya başladık :

• Çok basit kurulum
• Yığın belgelerde hızlı arama yapmak için yerleşik bir dizinleyiciye sahiptir
• İş akışlarına, gruplara ve gerekirse müşterilerin belgelere özel erişimine izin verir
• Açık kaynak
• Aktif topluluk
• LDAP / AD / SSO entegrasyonu
• Birçok farklı belgeyi işler

Ayrıca bazı dezavantajları vardır:

• Kullanıcı arayüzü her zaman sezgisel değildir
• Gerçekten bir wiki değil, bu yüzden bir belgedeki eşzamanlı ortak çalışma biraz kırılgan olabilir

Bir salıncak vermeye karar verirseniz, lütfen görüşlerinizle benimle iletişime geçin.

Başka bir olasılık, LaTeX veya başka bir metin formatlayıcı (belki de texinfo, hatta lout ) dokümantasyon için kullanılabilir. Bunun bir kısmı makine ile üretilebilir. HTML dönüşümü için HeVeA gibi LaTeX'i HTML'ye dönüştürmek için bazı araçlar vardır . Kaynak kodunuzdaki yapılandırılmış yorumlardan belge oluşturmak için doxygen'i de kullanabilirsiniz . Ve belgelerin elle yazılmış bölümleri kaynak kodu (örneğin, sürüm kontrolü ve derlemesi) olarak yönetilebilir (ve olmalıdır).

Belgelerinize ek olarak bir UML ve ERD aracı kullanmanızı öneririm. Ayrıca, bu belgeleri ZOHO'da ZOHO- Docs'ta saklayabilirsiniz , bu ücretsiz değildir, ancak son derece ucuzdur ve belge arama olanaklarına izin verir.

Hangi aracı kullanırsanız kullanın, metin aramasını kullanabilmek ve anlamlı sonuçlar elde edebilmek için belge içeriğini dikkatlice organize etmeniz gerekir. Belge içeriği organizasyonu, akıllı ve standart dosya adlandırma ile birlikte çok yardımcı olabilir.