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ở:
- Ngôn ngữ Julia
- Người viết nội dung kỹ thuật:
- sophb
- Tên dự án:
- Định hình lại trang web FluxML
- Thời lượng dự án:
- Thời gian 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 trong trang có cấu trúc và hấp dẫn đối với người mới tham gia 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 mục mới và tạo hướng dẫn bắt đầu mới cho người mới, mở rộng hướng dẫn của Flux 60-mine-blitz.
Dự án này 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 (để biết 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 người cố vấn để xác định các mục 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 hướng dẫn bắt đầu sử dụng hướng dẫn sử dụng Flux 60-mine-blitz làm điểm bắt đầu và xây dựng dựa trên đó.
Điều chỉnh cấu trúc thông tin: Cập nhật trang web bằng kế hoạch đã xác định khi cộng tác với những người 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 bản nháp đó. Nhận phản hồi từ người cố vấn. Khi tôi và người 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 nó 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ưới dạng README sang HTML: Nếu còn thời gian sau khi hoàn thành 4 giai đoạn chính, thì tôi có thể chuyển đổi các hướng dẫn hiện có thành README để có thể truy cập dễ dàng hơn trên trang web.
Để đạt được mục tiêu của dự án, tôi sẽ phối hợp rất chặt chẽ với cộng đồng Flux để hiểu tài liệu hiện có và xác định phương án tiếp cận tốt nhất. Tôi là người mới sử dụng Julia và tôi tin rằng thông tin 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 bắt đầu mới.
Tôi sẽ tập trung đảm bảo công việc của mình giúp cộng đồng Flux làm quen với các ứng 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à khám phá những thông tin chi tiết hơn về Flux.