Spesifikasyonlar ve dokümantasyon yazmak için Wiki benzeri araç [kapalı]


9

Bir yazılım projesi için teknik özellikleri ve belgeleri yazmak ve yönetmek için wiki veya wiki benzeri bir sistem arıyorum.

Çok sayıda wiki uygulaması olduğunu biliyorum, ancak bu tür görevler için özellikle uygun olanlar var mı?

Aslında bir wiki olmak zorunda değil, sadece özellikleri ve belgeleri yazmayı ve gezinmeyi kolaylaştıran ve değişiklik izlemeyi destekleyen bir sistem.


1
Özel bir platform mu kullanıyorsunuz? Örneğin Microsoft'un TFS'si gibi mi?
Saeed Neamati

@Saeed'in sorduğu sorular doğrultusunda ekibinizin / kuruluşunuzun bilgi yönetimi ve paylaşımı için halihazırda ne tür altyapısı var? Ayrıca, teknik özellik ve doküman yazma ile ilgili mevcut işlemleriniz nelerdir?
Thomas Owens

Yanıtlar:


6

LaTeX ve SVN kullanıyoruz. LaTeX belgeleri sadece metin dosyaları olduğundan, bazı ikili veya kısmen ikili biçimlerin aksine, sürüm kontrolü ile iyi oynar.

Alıştığınız sürüm kontrolünün tüm avantajlarını (ve kuşkusuz) kodunuzla kullanmanız gerekir.

LaTeX (kendi stillerinizi / sınıfınızı tanımlamak için) küçük bir ayar yapar, ancak bunu yaptıktan sonra çok iyi - sunumundan ziyade yalnızca içeriğe konsantre olabilirsiniz (sürekli olarak tweak yapmak için cazip olmak yerine) WYSIWYG), yine de sonunda kaygan, profesyonel görünümlü bir PDF belgesi edinin.


4

Şahsen, Tiddly Wiki'yi gerçekten seviyorum .

Oldukça eksiksiz bir wiki sözdizimi vardır, kendi kendine yeten tek bir html dosyasıdır ve bir sunucuya ihtiyaç duymadan çeşitli web tarayıcılarıyla iyi çalışır.

Hatta, toplayıcıları şifrelemek veya dipnot eklemek gibi her türlü ilginç şeyi yapmak için eklentiler eklemenizi sağlayan genişletilebilir bir eklenti mimarisine sahiptir.


3

Microsoft platformu için, ShareS ile TFS (Team Foundation Server) entegrasyonu tam aradığınız şeydir. Yeni bir ekip projesi oluşturarak, yazılım geliştirme sürecinin neredeyse her yönünü kapsayan bir şablon seçebilirsiniz. Size ekip üyelerini tanımlayabileceğiniz, rollerini ve güvenlik izinlerini atayabileceğiniz, projenizle ilgili belgeleri ve özellikleri yükleyebileceğiniz, paylaşabileceğiniz, düzenleyebileceğiniz ve bununla birlikte çok sayıda harika şey yapabileceğiniz bir portal sunar.

Diğer platformlar için, GitHub gibi bir şey kullanabileceğinizi düşünüyorum (yine de bundan emin değilim).



0

Seçtiğiniz kaynak kontrol yönetimi altyapınıza teslim edilen belgelerle Sfenks'i deneyebilirsiniz . Bu, kaynak kontrolü ve nispeten hafif bir biçimlendirme dili avantajları vardır, reStructuredText , öğrenmesi kolay ve dönüşümler için oldukça iyi bir şekilde kullanılır (HTML'ye, PDF'ye vb.).

Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.