Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan proyek
- Organisasi open source:
- Tryton
- Penulis teknis:
- doni
- Nama project:
- Dokumentasi untuk Modul Dasar
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Dalam project ini, saya mengusulkan untuk meninjau dan memperbarui dokumentasi untuk modul dasar tryton. Ini adalah modul yang paling sering perlu diaktifkan orang saat menyiapkan sistem Tryton.
Peningkatan pada dokumentasi modul Tryton akan membantu pengguna menemukan modul yang tepat untuk kebutuhan mereka, lalu membantu mereka menyiapkan dan menggunakan sistem mereka. Dokumentasi modul yang baik akan memungkinkan pengguna menemukan jawaban atas beberapa pertanyaan dasar mereka tanpa perlu menunggu jawaban di forum diskusi.
Modul dasar minimal mencakup: modul akun, account_invoice, account_invoice_stock, account_product, company, country, currency, party, product, purchase, sale, dan stock.
Ada tiga audiens utama untuk dokumentasi Cobaton, pengguna, administrator sistem, dan developer. Untuk membantu menargetkan dokumentasi ke setiap modul tersebut, sebaiknya dokumentasi setiap modul dibagi menjadi file terpisah di dalam direktori dokumen. File ini dapat mencakup file yang berisi daftar isi dan deskripsi modul, petunjuk untuk menyiapkan modul, informasi tentang cara menggunakan modul, dan detail tentang desain serta struktur modul. Bergantung pada fungsi modul, beberapa file ini mungkin tidak diperlukan, dan file tambahan dapat dibuat sesuai kebutuhan. Peningkatan modul akan dilakukan seperti yang telah saya usulkan untuk modul pihak: https://codereview.tryton.org/297241003/#ps327231002
Menyusun dokumentasi seperti ini akan berfungsi dengan baik karena dokumentasi saat ini dibuat oleh Sphinx menggunakan file reStructuredText. Saat saya membuat perubahan pada dokumentasi, dokumentasi tersebut akan diupload ke situs peninjauan kode Cobaton, sehingga mereka dapat ditinjau, dan saya dapat memperbaruinya sesuai kebutuhan. Setelah semua orang puas dengan perubahan tersebut, perubahan tersebut dapat disetujui untuk disertakan dalam Tryton.