Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Tryton
- Tác giả kỹ thuật:
- dave
- Tên dự án:
- Tài liệu về các mô-đun cơ bản
- Độ dài dự án:
- Thời hạn tiêu chuẩn (3 tháng)
Mô tả dự án
Trong dự án này, tôi đề xuất xem xét và cập nhật tài liệu cho các mô-đun Tryton cơ bản. Đây là những mô-đun mà mọi người thường cần kích hoạt nhất khi thiết lập hệ thống Tryton.
Những điểm cải tiến trong tài liệu về mô-đun của tryton sẽ giúp người dùng tìm thấy các mô-đun phù hợp với nhu cầu của họ, sau đó giúp người dùng thiết lập và sử dụng hệ thống của mình. Tài liệu mô-đun tốt sẽ giúp người dùng tìm thấy câu trả lời cho một số câu hỏi cơ bản mà không cần phải chờ câu trả lời trên diễn đàn thảo luận.
Các mô-đun cơ bản tối thiểu bao gồm: account, account_invoice, account_invoice_stock, account_product, company, country, currency, party, product, purchase, sale và stock.
Có 3 đối tượng chính cho tài liệu về tryton là người dùng, quản trị viên hệ thống và nhà phát triển. Để giúp nhắm mục tiêu tài liệu đến từng mô-đun này, bạn nên chia tài liệu của mỗi mô-đun thành các tệp riêng biệt bên trong thư mục tài liệu. Các tệp này có thể bao gồm tệp chứa mục lục và nội dung mô tả về mô-đun, hướng dẫn thiết lập mô-đun, thông tin về cách sử dụng mô-đun và thông tin chi tiết về thiết kế và cấu trúc của mô-đun. Tuỳ thuộc vào chức năng của mô-đun, một số tệp trong số này có thể không bắt buộc và bạn có thể tạo các tệp bổ sung nếu cần. Các điểm cải tiến về mô-đun sẽ tương tự như những điểm tôi đã đề xuất cho mô-đun bên: https://codereview.tryton.org/297241003/#ps327231002
Việc sắp xếp tài liệu như vậy sẽ hiệu quả vì tài liệu hiện được Sphinx tạo bằng các tệp reStructuredText. Khi tôi thực hiện thay đổi đối với tài liệu, các thay đổi đó sẽ được tải lên trang web xem xét mã Tryton để có thể được xem xét và tôi có thể cập nhật các thay đổi đó nếu cần. Khi mọi người hài lòng với ứng dụng, họ có thể được phê duyệt để đưa vào tryton.