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ở:
- Ngôn ngữ Julia
- Người viết nội dung kỹ thuật:
- mkg33
- Tên dự án:
- Tài liệu hợp nhất về Học máy khoa học
- Thời lượng dự án:
- Chạy trong thời gian dài (5 tháng)
Mô tả dự án
Tôi muốn hợp tác nhằm hợp nhất tổ chức SciML vì còn rất nhiều điểm cần cải thiện trong lĩnh vực này và việc hoàn tất dự án này chắc chắn sẽ mang lại lợi ích tức thì cho cả lập trình viên Julia và người đóng góp/người duy trì tích cực của SciML. Các gói nằm rải rác trong SciML cung cấp một số công cụ thực sự hữu ích, nhưng luôn có nguy cơ người dùng không phát hiện được (đặc biệt là người mới) chỉ vì họ không thể khám phá gói đó và áp dụng gói đó cho vấn đề hiện tại.
Điều này khá khó chịu vì mục đích chính của các gói là tiếp cận nhiều đối tượng lập trình viên (cả người mới bắt đầu và chuyên gia). Để tránh tình huống được mô tả ở trên, tôi đề xuất sửa đổi kỹ lưỡng "trang chủ" của tài liệu SciML và tạo một loại trung tâm mà người dùng có thể sử dụng để duyệt xem các gói liên quan và khám phá hệ sinh thái đang phát triển. Tài liệu này cũng có thể đóng vai trò là tài liệu tham khảo có giá trị cho những người dùng có kinh nghiệm hơn và giúp họ làm việc hiệu quả hơn.
Trước tiên, tài liệu hiện có của tất cả các gói riêng lẻ cần được sửa đổi liên quan đến các vấn đề về văn phong cơ bản nhất (chẳng hạn như chính tả, dấu câu, ngữ pháp, v.v.). Để đảm bảo tính nhất quán về phong cách, SciML cần có một hướng dẫn cụ thể về phong cách (không thể thiếu để thực hiện các thay đổi hồi tố và để tham khảo sau này). Sẽ lãng phí thời gian nếu bạn bắt đầu lại từ đầu. Thay vào đó, bạn nên dựa trên các quy ước Julia hiện có và đưa vào các mục mới cho các vấn đề cụ thể về SciML.
Sau khi hoàn tất hướng dẫn về kiểu, tôi dự định sẽ sửa đổi tài liệu hiện tại trong giai đoạn thứ hai của dự án. Việc này sẽ giúp tài liệu trông chuyên nghiệp và ổn định hơn. Tôi đã tạo một số yêu cầu kéo để minh hoạ phương pháp của mình cho nhiệm vụ này. Trong giai đoạn này, tôi cũng dự định thiết kế (và triển khai) một hệ thống trích dẫn hiệu quả. Việc đầu tiên cần làm là cập nhật trang trích dẫn đã lỗi thời.
Giai đoạn thứ ba, có thể coi là quan trọng nhất, sẽ liên quan đến việc thiết kế lộ trình SciML, trong đó nhấn mạnh sự tương tác giữa các gói phân tán. Sự gắn kết giữa 2 gói càng chặt chẽ (liên quan đến vấn đề hoặc chính mã), thì những gói này càng nên xuất hiện ở gần hơn trong danh sách "xem thêm". Tôi đề xuất tạo hai khoá đề xuất: một khoá cho mức độ tương đồng về mã và một khoá cho mức độ tương đồng về vấn đề. Bằng cách này, người dùng có thể xác định các gói khác có thể hữu ích nhanh hơn nhiều so với việc duyệt qua các kho lưu trữ và tài liệu tương ứng. Thay vì liệt kê tất cả các mối liên kết có thể có giữa các gói, tôi muốn tập trung vào các mối liên kết lớn hơn và cố gắng trình bày các đường liên kết của chúng với các gói nhỏ hơn (phương thức này cũng sẽ được mở rộng để cập nhật các hướng dẫn cần chỉ ra mối liên kết với một gói khác). Phương pháp này đảm bảo rằng danh sách "xem thêm" sẽ cung cấp thông tin mà không cần liệt kê đầy đủ các tổ hợp gói.