Dự án Qubes OS

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ở:
Hệ điều hànhQubes
Người viết nội dung kỹ thuật:
c1e0
Tên dự án:
Tổng hợp hướng dẫn khắc phục sự cố
Thời lượng dự án:
Thời gian tiêu chuẩn (3 tháng)

Mô tả dự án

TÓM TẮT

Hướng dẫn khắc phục sự cố được thiết kế để giúp người dùng cuối giải quyết mọi vấn đề gặp phải khi sử dụng sản phẩm hoặc dịch vụ. Một hướng dẫn khắc phục sự cố hiệu quả đóng vai trò quan trọng vì có thể hỗ trợ người dùng khi có vấn đề phát sinh. Phương pháp này giúp người dùng không bỏ ngang sản phẩm khi họ gặp vấn đề. Qubes có hàng nghìn người dùng hằng ngày trên khắp thế giới, nhiều người trong số họ sẽ phải đối mặt với sự cố tại một thời điểm nào đó và sẽ được hưởng lợi từ hướng dẫn khắc phục sự cố.

TÌNH TRẠNG HIỆN TẠI CỦA HƯỚNG DẪN KHẮC PHỤC SỰ CỐ

Hiện tại, các hướng dẫn khắc phục sự cố QubesOS xuất hiện rải rác trên nhiều trang và đôi khi chưa hoàn chỉnh, dẫn đến việc họ liên tục đăng cùng một hướng dẫn nhiều lần khi giúp người dùng chẩn đoán sự cố. Hướng dẫn có sẵn thiếu bố cục hành động triệu chứng, khiến người dùng khó so khớp vấn đề với giải pháp. Ngoài ra, có một số vấn đề đã được đề cập nhiều lần trên mạng xã hội (Reddit), trang vấn đề của Qubes GitHub và trên diễn đàn #qubes-users (nhưng chưa được ghi lại trong hướng dẫn khắc phục sự cố hiện tại).

TẠI SAO HƯỚNG DẪN KHẮC PHỤC SỰ CỐ ĐƯỢC ĐỀ XUẤT CỦA TÔI CÓ CẢI TIẾN TRƯỚC SỰ KIỆN HIỆN TẠI?

Hướng dẫn khắc phục sự cố được đề xuất của tôi sẽ đầy đủ và có cấu trúc để đảm bảo độ chính xác và điều hướng dễ dàng. Phần hướng dẫn này sẽ trình bày những chỉ dẫn ngắn gọn giúp giải thích cách giải một vấn đề theo từng bước một. Phần này sẽ có bố cục hành động triệu chứng, trong đó nêu vấn đề, theo sau là đề xuất giải pháp để giải quyết vấn đề đó. Các biện pháp khắc phục sự cố sẽ được tối ưu hoá cho công cụ tìm kiếm và diễn đạt nội dung để xem xét những vấn đề mà người dùng đang tìm kiếm trên mạng xã hội và công cụ tìm kiếm. Tất cả những điều này sẽ nhằm đảm bảo rằng người dùng có thể tìm thấy hướng dẫn khắc phục sự cố chính thức thông qua các công cụ tìm kiếm và nhanh chóng/dễ dàng tìm ra giải pháp cho vấn đề của họ

CẤU TRÚC CỦA HƯỚNG DẪN KHẮC PHỤC SỰ CỐ ĐƯỢC ĐỀ XUẤT và KHUNG THỜI GIAN

Tôi đã tạo một cấu trúc đề xuất cho hướng dẫn khắc phục sự cố hệ điều hành Qubes có thể tìm thấy tại đây: https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPFPSwZEaczqL8/edit?usp=sharing. Bố cục này đi kèm với một khung thời gian ước tính, trong đó mỗi phần khắc phục sự cố sẽ được viết. Bố cục này sẽ được triển khai sau khi có ý kiến phản hồi của người cố vấn. Chúng tôi có thể điều chỉnh cấu trúc và khung thời gian dựa trên ý kiến phản hồi của người cố vấn.

MỤC TIÊU DỰ ÁN

  • Điều chỉnh cấu trúc của hướng dẫn khắc phục sự cố để xây dựng một bố cục hành động dấu hiệu thống nhất và dễ hiểu hơn.
  • Viết lại các sự cố hiện có để có hướng dẫn từng bước dễ thực hiện.
  • Thêm ảnh chụp màn hình khi cần
  • Tự cài đặt và dùng thử Qubes và ghi lại mọi sự cố gặp phải. Tôi có ba máy tính: một chiếc Lenovo Thinkpad, Dell Latitude và Acer Aspire. Tôi sẽ thử Qubes trên mỗi máy tính này, ghi lại mọi lỗi và xác thực mọi sự cố khắc phục.
  • Xoá mọi thông tin lỗi thời trong hướng dẫn hiện có.
  • Đảm bảo khắc phục sự cố là chính xác. Kể từ bây giờ, các hướng dẫn khắc phục sự cố hiện có có thông báo lỗi ""Đây là tài liệu không chính thức của bên thứ ba. Dự án Qubes OS không thể đảm bảo tính chính xác của trang này. Hãy thận trọng"". Cảnh báo này sẽ bị loại bỏ sau khi các hướng dẫn khắc phục sự cố được xác minh là chính xác. Độ chính xác của kết quả này sẽ được đảm bảo bằng cách trực tiếp kiểm tra sự cố trên máy tính của tôi (nếu có thể) hoặc kiểm tra trên mạng xem có người dùng nào đã xác thực giải pháp hay chưa.
  • Di chuyển mọi mục khắc phục sự cố bên ngoài (từ diễn đàn và GitHub) sang trang web khắc phục sự cố chính thức.
  • Nghiên cứu và tìm thêm những rắc rối mà người dùng gặp phải từ các vấn đề liên quan đến Reddit (r/QubesOS), Stack Exchange, #qubes-users Google Groups và các vấn đề trên GitHub. Tôi cũng sẽ sử dụng các công cụ nghiên cứu từ khoá như Keywordtool.io và Ubersuggest.com để tìm ra những câu hỏi thường được tìm kiếm trên các công cụ tìm kiếm như Google.
  • Thêm mục "Nhận trợ giúp", trong trường hợp hướng dẫn khắc phục sự cố không giải quyết được vấn đề của người dùng. Bạn có thể xem ví dụ trên trang khắc phục sự cố của Fedora: https://docs.fedoraproject.org/en-US/fedora/rawhidden/install-guide/install/Troubleshooting/#sect-troubleshooting-Tải-help.

LÝ DO CHÚNG TÔI RA MẮT DỰ ÁN NÀY

Tôi đam mê công nghệ, đặc biệt là an ninh mạng và quyền riêng tư. Tôi tin rằng viết là một trong những điều mình thích hợp nhất. Tôi đặc biệt quan tâm đến Qubes OS vì hệ điều hành này giao thoa hai lợi ích chính của tôi: bảo mật và quyền riêng tư. Tôi là người thích dùng các sản phẩm tập trung vào quyền riêng tư và bảo mật khác như DuckDuckGo và Tor. Tôi mới khám phá ra Qubes OS gần đây và đến nay vẫn rất thích ứng dụng này.

TẠI SAO TÔI TIN RẰNG TÔI LÀ NGƯỜI PHÙ HỢP CHO DỰ ÁN NÀY

  • Tôi đam mê bảo mật, quyền riêng tư và viết tài liệu hay/hữu ích.
  • Vì đã gặp vấn đề khi cài đặt và sử dụng Qubes OS, nên tôi có thể trình bày rõ hơn về những vấn đề này trong phần hướng dẫn khắc phục sự cố.
  • Trong tháng trước, tôi đã tìm hiểu về các khía cạnh kỹ thuật của Hệ điều hành Qubes. Tôi cũng đã nghiên cứu kỹ tài liệu về Qubes OS. Để nắm được quy trình chỉnh sửa tài liệu, tôi đã tạo một yêu cầu lấy dữ liệu (https://github.com/QubesOS/qubes-doc/pull/1005/files)
  • Gần đây, tôi đã hoàn thành một thực tập tại dự án Tor. Công việc của tôi là hỗ trợ kỹ thuật và viết lách. Trong khi làm việc tại bộ phận trợ giúp, tôi đã nhận được hàng trăm câu hỏi của những người dùng gặp phải rắc rối khi cài đặt hoặc sử dụng Trình duyệt Tor. Bằng cách giúp những người dùng này khắc phục vấn đề của họ, tôi đã học được cách viết hướng dẫn khắc phục sự cố ngắn gọn và dễ hiểu
  • Trong quá trình làm việc tại Dự án Tor, tôi cũng viết tài liệu kỹ thuật bằng Markdown. Tôi đã sử dụng Git, GitHub và GitLab để quản lý phiên bản.