Tehnik Dokumentasi Amplikasi

Dokumentasi Proyek Rencana

Yang mengelola dokumentasi OpenACS telah berkembang melalui beberapa fase. Ini adalah draft rencana untuk tahap saat ini yang kita mulai. Silahkan kirimkan komentar tentang rencana ini ke forum Pembangunan OpenACS (atau dalam konteks dengan halaman wiki yang sesuai;)

Latar belakang

Sejarah dokumentasi OpenACS: .. mulai dengan membangun basis dokumentasi yang baik dari ACS ArsDigita di akhir 1990-an. ACS dokumentasi sebagian besar ditulis dalam DocBook 

Lihat doc-sejarah

Tujuan

untuk menulis dokumentasi yang luar biasa, sehingga pengguna, pengembang dan administrator instalasi OpenACS dapat menikmati bekerja dengan dan menggunakan sistem (dengan sedikit sakit kepala! =)

Cakupan

Dokumentasi API: tidak ada rencana untuk memindahkan dokumentasi API untuk XoWiki. Yang seharusnya tetap seperti itu.
DocBook docs di: http://openacs.org/doc/index.html perlu dilakukan kerja yang signifikan.

Persyaratan

Persyaratan adalah tentang pengaturan spesifikasi dan tonggak kita dapat memverifikasi, dan termasuk eksplorasi skenario, kasus penggunaan dll
Berikut adalah dokumentasi persyaratan untuk:

• Untuk setiap persyaratan di bawah ini, termasuk link ke tutorial dan dokumentasi pengembang lainnya untuk lebih detail.
• Jelaskan gambaran struktural dari sebuah sistem bekerja dan bagaimana komponen bekerja sama. "Pandangan Layered Kue" pandangan umum sistem jaringan, sebuah tabel yang menunjukkan tingkat sistem dibandingkan peran untuk membantu dengan pemahaman bagaimana subsistem yang saling berhubungan.
• Berikan penjelasan komprehensif dari proses administrasi khas untuk operasi sistem OpenACS bertanggung jawab, termasuk membaca catatan dan pandangan baris perintah yang menggambarkan status dari berbagai proses yang aktif.
  
  
  • prasyarat negara instalasi. Sebagai contoh: "Anda harus membaca melalui proses instalasi untuk membiasakan diri dengan proses instalasi, sebelum memulai instalasi.

• docs-admin-p'mint
• docs-install-p'mint

Tersedia sumber daya

• relawan yang berdedikasi untuk secara teratur mengelola dan memperbarui dokumentasi
• lainnya relawan yang berkontribusi dokumentasi yang berharga bisa dibilang lebih kurang sering (seperti artikel majalah;) (dan mungkin perlu beberapa bantuan untuk memiliki dll sesuai dengan pekerjaan mereka ke docs baik.)
• openacs.org situs, termasuk penggunaan xowiki
• software open-source, editor teks, pengecek ejaan, kode html validator dll

Pendekatan dalam manajemen dokumen dieksplorasi

• Sebuah komunitas yang tumbuh mengelilingi DocBook (memiliki mailing list)
• Sejumlah alat gratis dan komersial yang tersedia untuk mengedit dan penerbitan dokumen DocBook.
• DocBook memungkinkan kita untuk mempublikasikan dalam berbagai format.
• XML memisahkan konten dari presentasi: Ini mengurangi masing-masing kontributor dari beban presentasi, membebaskan setiap penulis untuk fokus pada konten dan berbagi pengetahuan.
• DocBook adalah teknologi yang sudah teruji baik. Ini telah dikembangkan sejak awal 1990-an).

 

Lihat Documentation_Project_Discussion

Strategi

Strategi adalah tentang menciptakan sebuah pendekatan untuk melakukan pekerjaan. Ini panduan perilaku dan keputusan-keputusan taktis pada usaha kerja.
Bentuk upaya dokumentasi berkelanjutan dengan menggunakan prinsip-prinsip perbaikan terus menerus untuk kembali insinyur produksi dan manajemen dokumentasi.
Pengembangan dokumentasi OpenACS tunduk pada kendala pengembangan proyek perangkat lunak dan metode pelepasan dan siklus (bagian yang disebut "Menggunakan CVS dengan OpenACS"). Pada dasarnya, semua fase pekerjaan mungkin aktif untuk mengakomodasi sifat asynchronous beberapa sub-proyek berkembang oleh upaya basis global peserta dengan referensi waktu beragam budaya dan kekhasan penjadwalan.
Strategi dokumentasi adalah dengan menggunakan metode proyek untuk melibatkan orang lain dengan berkolaborasi atau mendapatkan bimbingan atau umpan balik (peer review) untuk mendistribusikan beban kerja dan meningkatkan nilai keseluruhan dari output untuk proyek OpenACS.

Struktur Perincian Kerja

Adalah tentang eksplisit menyatakan cara untuk menerapkan strategi sebagai satu set tonggak dan metode untuk digunakan.
Status: ini adalah dokumen draft, sehingga tidak ada konsensus pada WBS saat ini. Lihat Documentation_Project_Discussion untuk aktivitas saat ini.

Verifikasi

Ini adalah di mana kita mengukur seberapa baik rencana ini dilaksanakan. Sukses diukur oleh A) memverifikasi jika proyek telah memenuhi tujuan didirikan dan persyaratan, dan B) meninjau untuk daerah masalah yang sedang berlangsung dll Pengamatan kemudian membantu untuk memodifikasi rencana revisi dokumentasi berikutnya.
OpenACS berikut verifikasi melalui sarana yang berbeda pada proyek yang berbeda, tetapi dalam semua kasus, masyarakat OpenACS memverifikasi proyek sebagai keberhasilan melalui umpan balik termasuk laporan bug, pengguna dan komentar administrator, dan perubahan kode.

Link terkait dan sumber

• Documentation_Project_Discussion
• Garutpedia-pemberitahuan
• [Structure_Ideas]

Posted in: TDA2