Dự án Qubes OS

Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.

Tóm tắt dự án

Tổ chức nguồn mở:
Hệ điều hành Qubes
Tác giả kỹ thuật:
c1e0
Tên dự án:
Consolidate troubleshooting guides
Thời lượng dự án:
Thời hạn tiêu chuẩn (3 tháng)

Mô tả dự án

ABSTRACT

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ố phù hợp đóng vai trò quan trọng vì nó sẽ hỗ trợ người dùng khi sự cố phát sinh. Nhờ đó, người dùng không bỏ dở sản phẩm khi 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ẽ gặp phải vấn đề vào 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ố.

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 nằm rải rác trên nhiều trang và đôi khi chưa hoàn chỉnh, dẫn đến việc đăng đi đăng lại cùng một hướng dẫn khi giúp người dùng chẩn đoán sự cố. Các hướng dẫn hiện có thiếu bố cục triệu chứng-hành độ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 đề Qubes Github và trên diễn đàn #qubes-users, nhưng chưa được ghi nhận trong hướng dẫn khắc phục sự cố hiện tại.

VÌ SAO HƯỚNG DẪN KHẮC PHỤC SỰ CỐ MÀ TÔI ĐỀ XUẤT LẠI TỐT HƠN HƯỚNG DẪN HIỆN TẠI?

Hướng dẫn khắc phục sự cố mà tôi đề xuất sẽ đầy đủ và có cấu trúc để đảm bảo tính chính xác và dễ dàng thao tác. Hướng dẫn này sẽ trình bày hướng dẫn ngắn gọn giải thích cách giải quyết vấn đề theo từng bước. Video này sẽ có bố cục hành động theo triệu chứng, trong đó nêu rõ vấn đề, sau đó đưa ra giải pháp được đề xuất để giải quyết vấn đề đó. Các bài viết khắc phục sự cố sẽ được tối ưu hoá cho công cụ tìm kiếm và được viết để 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ẽ giúp đả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 thấy 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ố Qubes OS. Bạn có thể xem hướng dẫn này tại đây: https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPfpSwZEaczqL8/edit?usp=sharing. Bố cục này đi kèm với 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 bạn nhận được ý kiến phản hồi của người cố vấn. Bạn có thể sửa đổi 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 CỦA DỰ ÁN

  • Điều chỉnh cấu trúc của hướng dẫn khắc phục sự cố để có một bố cục hợp nhất và dễ hiểu hơn về hành động liên quan đến triệu chứng.
  • Viết lại các bài viết khắc phục sự cố hiện có để có hướng dẫn từng bước dễ làm theo.
  • Thêm ảnh chụp màn hình khi cần
  • Tự cài đặt và dùng thử Qubes, đồng thời ghi lại mọi vấn đề gặp phải. Tôi có ba máy tính: Lenovo Thinkpad, Dell Latitude và Acer Aspire. Tôi sẽ thử Qubes trên từng máy tính trong số này, ghi lại mọi lỗi và xác thực mọi biện pháp khắc phục sự cố.
  • Xoá mọi thông tin lỗi thời trong hướng dẫn hiện có.
  • Đảm bảo các sự cố đều chính xác. Hiện tại, 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. Vui lòng thận trọng"". Cảnh báo này sẽ bị loại bỏ sau khi hướng dẫn khắc phục sự cố được xác minh là chính xác. Tôi sẽ đảm bảo độ chính xác của các giải pháp này bằng cách tự kiểm tra các bước khắc phục sự cố trên máy tính của mình (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 không.
  • Di chuyển mọi nội dung 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 vấn đề mà người dùng gặp phải trên Reddit (r/QubesOS), Stack Exchange, #qubes-users và GitHub. Tôi cũng sẽ sử dụng các công cụ nghiên cứu từ khoá như Keywordtool.io và Ubersuggested.com để khám phá xem những câu hỏi nào thường được tìm kiếm trên các công cụ tìm kiếm như Google.
  • Thêm phần "Yêu cầu trợ giúp" phòng 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ụ trong trang khắc phục sự cố của Fedora: https://docs.fedoraproject.org/en-US/fedora/rawhide/install-guide/install/Troubleshooting/#sect-troubleshooting-getting-help.

TẠI SAO CÓ 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ách là một trong những thế mạnh của mình. Tôi đặc biệt quan tâm đến Qubes OS vì hệ điều hành này kết hợp hai mối quan tâm chính của tôi: bảo mật và quyền riêng tư. Tôi là một người dùng cuồng nhiệt các sản phẩm khác tập trung vào quyền riêng tư và bảo mật như DuckDuckGo và Tor. Gần đây tôi mới khám phá ra Qubes OS và tôi rất thích hệ điều hành này.

LÝ DO TÔI TIN RẰNG MÌNH LÀ NGƯỜI PHÙ HỢP VỚI DỰ ÁN NÀY

  • Tôi đam mê bảo mật, quyền riêng tư và viết tài liệu hữu ích.
  • Do đã gặp vấn đề khi cài đặt và sử dụng Qubes OS, tôi có thể trình bày rõ hơn về các vấn đề này trong phần hướng dẫn khắc phục sự cố.
  • Trong tháng qua, tôi đã nghiên cứu 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. Để hiểu rõ hơn về quy trình chỉnh sửa tài liệu, tôi đã tạo một yêu cầu lấy (https://github.com/QubesOS/qubes-doc/pull/1005/files)
  • Gần đây, tôi đã hoàn thành một chương trình thực tập tại dự án Tor. Tôi đảm nhận vai trò hỗ trợ kỹ thuật và viết nội dung. Trong thời gian làm việc tại bộ phận hỗ trợ, tôi đã nhận được hàng trăm câu hỏi từ những người dùng gặp sự cố khi cài đặt hoặc sử dụng Trình duyệt Tor. Khi giúp những người dùng này khắc phục sự cố, 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
  • Khi 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 để kiểm soát phiên bản.