Trang này chứa thông tin chi tiết về một dự án viết tài liệu kỹ thuật được chấp nhận cho Google Season of Docs.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Qubes OS
- Chuyên viên viết tài liệu kỹ thuật:
- luzeal
- Tên dự án:
- Làm quen với QubesOS! Hãy viết một hướng dẫn mở và dễ sử dụng
- Thời lượng dự án:
- Thời hạn tiêu chuẩn (3 tháng)
Mô tả dự án
Làm quen với QubesOS!
Tôi muốn tạo một hướng dẫn mở và các tài liệu liên quan cho người dùng QubesOS lần đầu. Mục tiêu là giới thiệu QubesOS cho người dùng bình thường, đồng thời giữ cho hướng dẫn này ngắn gọn và dễ hiểu nhất có thể, bằng cách sử dụng các phép loại suy, hình minh hoạ và sơ đồ. Để giữ cho nội dung ngắn gọn, chúng tôi sẽ sử dụng các đường liên kết đến các tài nguyên đáng tin cậy, bao gồm cả những tài nguyên có trên trang web QubesOS. Mọi thứ sẽ được phát hành theo một giấy phép mở.
Độc lập có nghĩa là một phần nội dung có thể tồn tại độc lập với trang web, chẳng hạn như một sổ tay. Nội dung này không tương đương với phiên bản ngoại tuyến của hướng dẫn. Lý tưởng nhất là bạn nên tạo một quy trình khác để xuất bản nội dung dưới dạng hướng dẫn, cùng với trang web.
Tôi muốn nói đến một hướng dẫn được phát hành theo giấy phép mở.
Cách thực hiện
Xác định đối tượng mục tiêu
Tính đến thời điểm hiện tại, tôi nhận thấy danh mục người dùng mà QubesOS nhắm đến chưa được xác định rõ ràng. QubesOS có thể giúp gì cho nhà báo, luật sư, nhà phân tích bảo mật, nhà phát triển phần mềm, v.v.? Sẽ rất hữu ích nếu bạn mô tả các trường hợp mà QubeOS có thể hữu ích.
Đặt kỳ vọng đúng cách
Bạn cũng nên cảnh báo người dùng lần đầu rằng QubesOS đòi hỏi họ phải có kiến thức tương đối về công nghệ thông tin. Bạn sẽ phải trả giá để sử dụng QubesOS, đặc biệt là về khả năng sử dụng, nếu QubesOS là hệ thống máy tính chính của bạn. Tương tự, QubeOS sẽ không hoạt động tốt (theo thiết kế) trong một số trường hợp, chẳng hạn như tăng tốc 3D trong máy ảo. Điều quan trọng là bạn phải làm rõ ngay từ đầu, không phải để ngăn mọi người sử dụng mà là để đặt ra kỳ vọng cho người dùng tiềm năng.
QubesOS là gì và không phải là gì
Mặc dù QubesOS là một hệ điều hành đặc biệt (một bản phân phối Xen), nhưng sẽ rất thú vị khi so sánh hệ điều hành này với các hệ điều hành khác dựa trên chức năng của chúng hoặc việc thiếu chức năng (ví dụ: Windows ngày càng sử dụng ảo hoá và hộp cát làm cơ chế bảo mật). Bạn có thể sử dụng một sơ đồ/bảng đơn giản.
Quy cách của hướng dẫn sẽ được xác định cùng với cộng đồng.
Hướng dẫn phải có tối thiểu những thông tin nào? Có thể đơn giản hoá quy trình cài đặt đến mức nào mà không ảnh hưởng đến tính bảo mật? Ngưỡng nên là bao nhiêu? Có một thứ gọi là thiết lập QubesOS tối thiểu khả dụng và an toàn không? Nếu không, bạn có thể xác định và đặt làm mục tiêu cho hướng dẫn.
Giấy phép
Mua giấy phép. Trang wiki Archlinux được nhiều người tôn trọng đang sử dụng Giấy phép Tài liệu Miễn phí của GNU phiên bản 1.3 trở lên. Giấy phép này có phù hợp không?
Các nỗ lực khác
Giúp tài liệu trang web trở nên hấp dẫn hơn về mặt hình ảnh
Bạn có thể đánh dấu các ghi chú bằng màu đỏ hoặc màu vàng để dễ dàng nhận thấy. Ví dụ: bạn có thể sử dụng các hộp màu, chẳng hạn như các hộp màu trong wiki của archlinux: https://wiki.archlinux.org/index.php/Linux_Containers.
Bạn có thể sử dụng trích dẫn khối.
Nội dung liên kết
Hiện tại, trang web tài liệu có khá nhiều nội dung, nhưng các phần riêng lẻ thường không được liên kết với các chủ đề có liên quan khác. Các bài viết có thể được liên kết với nhau để tăng khả năng được khám phá.