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