Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- Cobaton
- Penulis teknis:
- salman
- Nama proyek:
- Dokumentasi untuk Modul Dasar
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Dalam proyek ini saya mengusulkan untuk meninjau dan memperbarui dokumentasi untuk modul-modul Triton dasar. Ini adalah modul yang paling sering harus diaktifkan orang saat menyiapkan sistem Triton.
Peningkatan pada dokumentasi modul tryton akan membantu pengguna menemukan modul yang tepat untuk kebutuhan mereka, dan kemudian membantu mereka dalam menyiapkan dan menggunakan sistem. Dokumentasi modul yang baik akan memungkinkan pengguna untuk menemukan jawaban atas beberapa pertanyaan dasar mereka tanpa perlu menunggu jawaban di forum diskusi.
Modul dasar mencakup minimal: account, account_invoice, account_invoice_stock, account_product, perusahaan, negara, mata uang, pihak, produk, pembelian, penjualan, dan modul stok.
Ada tiga audiens utama untuk dokumentasi Triton, pengguna, administrator sistem, dan developer. Untuk membantu menargetkan dokumentasi ke setiap modul, sebaiknya dokumentasi setiap modul dibagi menjadi beberapa file terpisah di dalam direktori dokumen. Ini dapat mencakup file yang berisi daftar isi dan deskripsi modul, petunjuk untuk menyiapkan modul, informasi tentang cara menggunakan modul, dan detail tentang desain dan struktur modul. Bergantung pada fungsi modul, beberapa file ini mungkin tidak diperlukan, dan file tambahan dapat dibuat sesuai kebutuhan. Peningkatan modul akan mengikuti apa yang telah saya usulkan untuk modul pihak: https://codereview.tryton.org/297241003/#ps327231002
Penyusunan dokumentasi seperti ini akan berfungsi dengan baik karena dokumentasi saat ini dibuat oleh Sphinx menggunakan file reStructuredText. Saat saya membuat perubahan pada dokumentasi, perubahan tersebut akan diupload ke situs tinjauan kode tryton, sehingga dapat ditinjau, dan saya dapat memperbaruinya sesuai kebutuhan. Setelah puas dengan hasilnya, semua orang dapat, diharapkan, disetujui untuk disertakan dalam tryton.