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ở:
- Cơ sở hạ tầng trình biên dịch LLVM
- Người viết nội dung kỹ thuật:
- DR87
- Tên dự án:
- Sắp xếp lại cấu trúc chỉ mục tài liệu LLVM và hướng dẫn về quy tắc lập trình tài liệu
- Thời lượng dự án:
- Thời gian tiêu chuẩn (3 tháng)
Mô tả dự án
Dự án này bao gồm các nhiệm vụ sau:
a.) Điều chỉnh cấu trúc trang chỉ mục tài liệu để mang đến một trải nghiệm thân thiện hơn với người dùng. Nhiệm vụ này sẽ liên quan đến việc đánh giá trang hiện tại và tái cấu trúc trang dựa trên sự kết hợp của nghiên cứu độc lập, các cuộc phỏng vấn SME và phản hồi của người dùng. Các lựa chọn có thể là sửa đổi nội dung mô tả ngắn, tái cấu trúc trang hiện tại và/hoặc thêm các lớp (trang) bổ sung thông qua mô hình công bố thông tin tăng tiến. Chính sách sau sẽ làm giảm số lượng liên kết trên trang chỉ mục chính để giúp người dùng tìm thông tin/hướng dẫn cụ thể dễ dàng hơn. Ví dụ: chỉ mục có thể bao gồm các đường liên kết đến các trang riêng biệt về Thiết kế và Tổng quan về LLVM, Hướng dẫn sử dụng, Tài liệu về hệ thống con và Tài liệu về quy trình phát triển.
b.) Cập nhật hướng dẫn quy tắc LLVM Sphinx cho cộng tác viên nguồn mở. Nhiệm vụ này bao gồm việc đánh giá tài liệu hướng dẫn hiện tại, xác định những thiếu sót thông qua hoạt động nghiên cứu độc lập và phỏng vấn SME, cũng như cập nhật tài liệu hướng dẫn này dựa trên các yêu cầu đã thống nhất. Các điểm cập nhật có thể bao gồm việc sắp xếp lại bố cục của hướng dẫn, thêm nội dung mới và chèn đường liên kết đến các trang có liên quan, chẳng hạn như hướng dẫn dành cho cộng tác viên. Mục tiêu cuối cùng là giúp các tình nguyện viên bắt đầu đóng góp càng sớm càng tốt.