Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Phần Google Tài liệu.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Tryton
- Người viết nội dung kỹ thuật:
- dave
- Tên dự án:
- Tài liệu về các mô-đun cơ bản
- Thời lượng dự án:
- Thời gian 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 cải tiến đối với tài liệu về mô-đun của tryton sẽ giúp người dùng tìm thấy mô-đun phù hợp với nhu cầu của họ, sau đó giúp họ thiết lập và sử dụng hệ thống. Tài liệu về mô-đun hiệu quả sẽ cho phép người dùng tìm ra câu trả lời cho một số câu hỏi cơ bản của họ mà không cần 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 các mô-đun tài khoản, account_invoice, account_invoice, account_invoice, account_product, công ty, quốc gia, đơn vị tiền tệ, bên, sản phẩm, mua, bán và chứng khoán.
Tài liệu về tryton có 3 đối tượng chính 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, tôi khuyên bạn nên chia tài liệu của mỗi học phần thành các tệp riêng biệt bên trong thư mục tài liệu. Những tài liệu này có thể bao gồm các 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 cần thiết và bạn có thể tạo thêm các tệp khi cần. Các cải tiến mô-đun sẽ được thực hiện theo những đề xuất 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ư thế này sẽ hoạt động hiệu quả vì tài liệu này hiện được Sphinx tạo bằng các tệp reStructureText. Khi tôi sửa đổi tài liệu, thông tin đó sẽ được tải lên trang web xem xét mã của tryton để được xem xét và tôi có thể cập nhật theo yêu cầu. Khi mọi người đã hài lòng với bản trình bày của mình, họ có thể hy vọng rằng họ sẽ được phê duyệt để đưa vào tryton.