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 tài liệu của Google.
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:
- Điều chỉnh cấu trúc chỉ mục tài liệu LLVM và hướng dẫn về văn phong 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.) Tái cấu trúc trang chỉ mục tài liệu để mang đến trải nghiệm thân thiện hơn cho người dùng. Nhiệm vụ này sẽ bao gồm việc đánh giá trang hiện tại và tái cấu trúc trang đó dựa trên kết quả nghiên cứu độc lập, cuộc phỏng vấn với doanh nghiệp vừa và nhỏ và ý kiến phản hồi của người dùng. Bạn có thể sửa đổi nội dung mô tả ngắn, tái cấu trúc trang hiện có và/hoặc thêm các lớp (trang) khác thông qua mô hình công bố thông tin tăng dần. Cách thứ hai sẽ giúp giảm số lượng đường liên kết trên trang chỉ mục chính để người dùng dễ dàng tìm thấy thông tin/hướng dẫn cụ thể. 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 cho phần 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 về phong cách LLVM Sphinx cho những người đóng góp nguồn mở. Nhiệm vụ này sẽ bao gồm việc đánh giá hướng dẫn hiện tại, xác định những thiếu sót thông qua nghiên cứu độc lập và phỏng vấn SME, đồng thời cập nhật hướng dẫn dựa trên các yêu cầu đã thoả thuận. Nội dung 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 tình nguyện viên dễ dàng bắt đầu đóng góp sớm nhất có thể.