Alat seperti wiki untuk spesifikasi dan dokumentasi penulisan [tertutup]


9

Saya mencari wiki atau sistem seperti wiki untuk menulis dan mengelola spesifikasi dan dokumentasi untuk proyek perangkat lunak.

Saya tahu ada banyak implementasi wiki yang tersedia, tetapi apakah ada beberapa yang sangat cocok untuk tugas semacam ini?

Sebenarnya itu tidak harus menjadi wiki, hanya sebuah sistem yang membuatnya mudah untuk menulis dan menavigasi spesifikasi dan dokumentasi, dan yang mendukung pelacakan perubahan.


1
Apakah Anda menggunakan platform khusus? Seperti TFS Microsoft misalnya?
Saeed Neamati

Sejalan dengan apa yang diminta @Saeed, infrastruktur apa yang sudah dimiliki tim / organisasi Anda untuk manajemen dan berbagi pengetahuan? Juga, apa proses Anda saat ini untuk menulis spesifikasi dan dokumen?
Thomas Owens

Jawaban:


6

Kami menggunakan LaTeX dan SVN. Karena dokumen LaTeX hanyalah file teks, ia berfungsi dengan baik dengan kontrol versi, tidak seperti beberapa format biner atau sebagian biner.

Anda mendapatkan semua kelebihan (dan kerugian, diakui) dari kontrol versi yang biasa Anda gunakan dengan kode Anda.

LaTeX membutuhkan sedikit pengaturan (untuk menentukan gaya / kelas Anda sendiri), tetapi begitu Anda selesai melakukannya, itu sangat bagus - Anda dapat berkonsentrasi hanya pada konten daripada presentasinya (daripada tergoda untuk terus-menerus mengutak-atik seperti saat Anda bersama WYSIWYG), namun masih mendapatkan dokumen PDF yang apik dan profesional di bagian akhir.


4

Secara pribadi, saya sangat suka Tiddly Wiki .

Ini memiliki sintaks wiki yang cukup lengkap, adalah file html tunggal mandiri dan berfungsi dengan baik dengan berbagai browser web tanpa perlu server.

Bahkan memiliki arsitektur plugin yang dapat diperluas yang memungkinkan Anda untuk menambahkan plugin untuk melakukan segala macam hal menarik seperti mengenkripsi tiddlers atau menambahkan catatan kaki.


3

Untuk platform Microsoft, integrasi TFS (Team Foundation Server) dengan SharePoint adalah apa yang Anda cari. Dengan membuat proyek tim baru, Anda dapat memilih templat yang mencakup hampir setiap aspek proses pengembangan perangkat lunak. Ini memberi Anda sebuah portal di mana Anda dapat menentukan anggota tim, menetapkan peran dan izin keamanan mereka, mengunggah, berbagi, dan mengedit dokumen dan spesifikasi yang terkait dengan proyek Anda, dan melakukan banyak hal keren lainnya dengannya.

Untuk platform lain, saya pikir Anda dapat menggunakan sesuatu seperti GitHub (walaupun, saya tidak yakin tentang itu).


0

Untuk proyek pribadi (hanya ada di PC saya) saya menggunakan Wiki di Jar . Di masa lalu saya bekerja dengan Redmine (lebih jauh lagi sistem pelacakan bug dan SCM)


0

Anda dapat mencoba Sphinx , dengan dokumen-dokumen diperiksa ke dalam infrastruktur manajemen sumber kontrol pilihan Anda. Ini memiliki keuntungan dari kontrol sumber dan bahasa markup yang relatif ringan, reStructuredText , yang mudah dipelajari dan diinstrumentasi dengan cukup baik untuk konversi (ke HTML, ke PDF, dan sebagainya).

Dengan menggunakan situs kami, Anda mengakui telah membaca dan memahami Kebijakan Cookie dan Kebijakan Privasi kami.
Licensed under cc by-sa 3.0 with attribution required.