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:
- sophb
- Tên dự án:
- Tái tạo trang web FluxML
- Thời lượng dự án:
- Thời hạn tiêu chuẩn (3 tháng)
Mô tả dự án
Đề xuất này nhằm cải thiện trang web tài liệu của Flux để thông tin trên trang web này được sắp xếp hợp lý và hấp dẫn cả người mới và chuyên gia. Cụ thể hơn, mục tiêu là sắp xếp lại tài liệu hiện có thành các phần mới và tạo một hướng dẫn mới về cách bắt đầu dành cho người mới, mở rộng hướng dẫn Flux 60-mine-blitz.
Dự án này bao gồm các giai đoạn sau:
Phân tích trang web tài liệu hiện tại: Kiểm tra thông tin hiện có và xác định hướng dẫn quy tắc (cho thông tin) để tạo hướng dẫn mới.
Xác định cấu trúc mới cho thông tin và hướng dẫn bắt đầu: Làm việc với các cố vấn để xác định các phần mới và sắp xếp lại trang web tài liệu. Ngoài ra, hãy xác định mục lục cho phần hướng dẫn bắt đầu sử dụng hướng dẫn về Flux 60-mine-blitz làm điểm bắt đầu và xây dựng dựa trên đó.
Sắp xếp lại thông tin: Cập nhật trang web theo kế hoạch đã xác định được trong quá trình cộng tác với các cố vấn ở bước trước.
Tạo hướng dẫn bắt đầu: Viết bản nháp đầu tiên và xem lại. Nhận ý kiến phản hồi của các cố vấn. Khi tôi và các cố vấn xác định rằng chúng tôi đã có phiên bản cuối cùng của tài liệu này, tôi sẽ xuất bản tài liệu đó lên trang web tài liệu.
(Không bắt buộc) Chuyển đổi tài liệu hiện có ở dạng README sang HTML: Nếu còn thời gian sau khi hoàn thành 4 giai đoạn chính, tôi có thể chuyển đổi các hướng dẫn hiện có ở dạng README để người dùng dễ dàng truy cập hơn trên trang web.
Để đạt được mục tiêu của dự án, tôi sẽ làm việc rất chặt chẽ với cộng đồng Flux để tìm hiểu tài liệu hiện có và xác định phương pháp tốt nhất. Bản thân tôi cũng là người mới sử dụng Julia và tôi tin rằng điều này sẽ rất hữu ích trong việc xác định cấp độ thông tin phù hợp cho hướng dẫn mới về cách bắt đầu.
Tôi sẽ tập trung vào việc đảm bảo rằng công việc của mình sẽ giúp cộng đồng Flux làm quen với những cách sử dụng mới. Ngoài ra, tôi sẽ tập trung vào việc giúp người dùng có kinh nghiệm khám phá các trường hợp sử dụng mới và tìm hiểu thông tin chi tiết hơn về Flux.