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 Google Phần Tài liệu.
Tóm tắt dự án
- Tổ chức nguồn mở:
- HPX
- Người viết nội dung kỹ thuật:
- rstobaugh
- Tên dự án:
- Chỉnh sửa và đơn giản hoá tài liệu HPX hiện có
- Thời lượng dự án:
- Thời lượng tiêu chuẩn (3 tháng)
Mô tả dự án
Tôi đề xuất là chỉnh sửa và đơn giản hoá nội dung của tài liệu HPX hiện có. Đề xuất của tôi là dành cho một dự án có thời hạn tiêu chuẩn (ba tháng) tập trung vào việc sửa đổi hai chương trong tài liệu hướng dẫn của nhóm STE||AR: ""HPX Build System and Launching"" (1) và ""Định cấu hình các ứng dụng HPX"" (2).
Chương về ""Hệ thống xây dựng và triển khai HPX"" có một số lỗi ngữ pháp và cũng chứa từ ngữ khó hiểu và cách viết hoa không nhất quán như "CMake". Ngoài ra, chương trình còn chứa thông tin lặp lại mà tôi dự định sắp xếp lại, hợp nhất và cắt bớt nếu cần. Mặc dù chương về ""Định cấu hình ứng dụng HPX"" cũng có một số lỗi ngữ pháp cần được giải quyết, mối quan tâm chính của tôi đối với chương này là tính thân thiện với người dùng. Chương này có ba vấn đề chính về thiết kế mà tôi dự định giải quyết:
Một số tiêu đề bị che khuất trong văn bản, khiến bạn khó đọc lướt qua chương đó. Hiện tại, người dùng cần phải đọc kỹ hướng dẫn để hiểu rõ mục đích của từng bảng. Đây không phải là cách hầu hết người dùng tương tác với hướng dẫn sử dụng, đặc biệt là khi họ đã đọc nội dung trước đó. Thay vào đó, tôi dự định đảm bảo mỗi bảng đều có một tiêu đề rõ ràng, riêng biệt để người dùng có thể dễ dàng cuộn qua văn bản.
Khi liệt kê nhiều cơ sở lưu trú dưới một tiêu đề cụ thể, các cơ sở lưu trú đó không tuân theo thứ tự logic. Mặc dù các tài sản được nhóm lại với nhau theo một chủ đề chung, nhưng không có nhóm con nào, khiến thông tin có cảm giác bị phân tán. Ví dụ: người dùng có thể bắt gặp một số tài sản liên quan đến vị trí, một số tài sản lại liên quan đến một chủ thể khác, rồi bắt gặp một tài sản khác liên quan đến vị trí. Việc thiếu cấu trúc nội bộ trong các tiêu đề khiến việc tìm tất cả thông tin về một chủ đề phụ cụ thể trở nên khó khăn hơn. Do đó, tôi dự định sắp xếp lại một số biểu đồ để nhóm các thông tin tương tự với nhau một cách rõ ràng hơn trong từng tiêu đề.
Người dùng buộc phải di chuyển qua lại giữa các phần (hoặc mở hướng dẫn trong hai thẻ riêng biệt) để hiểu rõ một số hướng dẫn nhất định. Có những điểm trong đó chương hướng người dùng đến một câu duy nhất trong phần trước theo cách buộc người đọc cuộn lên hoặc đi theo một siêu liên kết để hiểu hướng dẫn chính xác, vì hướng dẫn sử dụng ngôn từ không rõ ràng như "bước này được tạo sẵn sau bước 11" trong phần trước. Mặc dù phương pháp này giúp loại bỏ việc lặp lại, nhưng lại khiến việc hiểu hướng dẫn trở nên khó khăn hơn vì đây là những công việc cần được tạo sẵn theo một thứ tự cụ thể. Thay vào đó, tôi đề xuất đưa vào từ ngữ cụ thể hơn để người dùng không phải làm gián đoạn quá trình đọc khi chuyển đổi giữa các phần hoặc tài liệu.
Nếu tôi hoàn thành các phần này trước khi hoàn thành tiến trình chuẩn, tôi cũng muốn dọn dẹp trang "Tại sao nên có HPX?" (3) trong Tài liệu người dùng của nhóm STE||AR. Trang này chứa nội dung giới thiệu lặp lại, mà tôi hy vọng sẽ củng cố và chứa những điểm không thống nhất về cách viết hoa (đặc biệt là biệt ngữ) và giọng nói, tạo cho trang một cảm giác không thống nhất. Mục tiêu của tôi là tạo một phần giới thiệu thống nhất, nhất quán hơn về cách làm việc của nhóm STE||AR.