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 Google Phần 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 lượng 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.
Các 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 các 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 mô-đun phù hợp sẽ cho phép người dùng tìm 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: tài khoản, account_invoice, account_invoice_stock, account_product, công ty, quốc gia, đơn vị tiền tệ, bên, sản phẩm, mua, bán và các mô-đun chứng khoán.
Có 3 đối tượng chính cho tài liệu về Dueton 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 cho từng học phần này, 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. Các 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ỳ 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 tệp khi cần. Những cải tiến mô-đun sẽ được thực hiện theo những gì tôi đã đề xuất cho mô-đun bên: https://codereview.tryton.org/297241003/#ps327231002
Việc cấu trúc tài liệu như thế này sẽ hiệu quả vì tài liệu hiện được Sphinx tạo bằng tệp reStructuredText. Khi tôi thay đổi tài liệu, các thay đổi đó sẽ được tải lên trang web xem xét mã tryton để tôi có thể xem xét và cập nhật theo yêu cầu. Khi mọi người đều đã hài lòng với những thay đổi này, hy vọng là họ có thể được phê duyệt đưa vào tryton.