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ở:
- Dự án Tor
- Người viết nội dung kỹ thuật:
- Swati Thacker
- Tên dự án:
- Viết lại trang hướng dẫn về Tor
- Thời lượng dự án:
- Lâu dài (5 tháng)
Mô tả dự án
Sau khi thảo luận với các cố vấn của TOR để hiểu rõ kỳ vọng của họ đối với dự án này, tôi đề xuất các ý tưởng sau để thiết lập cấu trúc và định dạng nhất quán cho trang Hướng dẫn TOR (https://2019.www.torproject.org/docs/tor-manual.html.en) nhằm biến trang này thành tài liệu tham khảo nhanh và hữu ích cho người dùng. Dự án này sẽ hoàn thành trong 3 tháng và các ý tưởng sau đây được chia theo tháng.
Tháng 1:
Tạo mục lục cho trang này. Mục lục sẽ bao gồm một chủ đề tổng quan và tiêu đề của tất cả 9 danh mục tuỳ chọn cấu hình. Vào cuối tháng này, người dùng sẽ có thể di chuyển đến các danh mục cấu hình khác nhau ngay trên đầu ngón tay. Mục lục sẽ có dạng như sau:
- Tổng quan – Thêm thông tin về nơi TOR duy trì cấu hình cho các danh mục tuỳ chọn này, nếu tất cả các danh mục này đều ở cùng một nơi, tên và vị trí mặc định của tệp cấu hình, quy tắc sử dụng các tuỳ chọn lệnh và cách người dùng có thể sửa đổi các tuỳ chọn này. (Chúng ta có thể đưa thông tin từ văn bản giới thiệu vào chủ đề THE CONFIGURATION FILE FORMAT (ĐỊNH DẠNG TỆP CẤU HÌNH)).
- Tuỳ chọn chung
- Tuỳ chọn ứng dụng
- Tuỳ chọn máy chủ
- Tùy chọn máy chủ thư mục
- Kiểm thử các tuỳ chọn mạng
- Các lựa chọn giảm thiểu cuộc tấn công Từ chối dịch vụ
- Tuỳ chọn máy chủ cơ quan quản lý thư mục
- Các tuỳ chọn dịch vụ bị ẩn
- Tuỳ chọn không cố định
Tháng 2:
Mục đích của trang hướng dẫn phải là nhanh chóng trả lời các câu hỏi về chức năng và cách thức hoạt động của từng tuỳ chọn. Hiện tại, các tuỳ chọn này không được ghi lại theo định dạng có cấu trúc và thông tin về từng tuỳ chọn được trình bày theo các đoạn văn bản, khiến bạn khó có thể xem nhanh thông tin. Bạn cần sắp xếp lại tất cả thông tin hiện có về các tuỳ chọn bằng một mẫu. Vào cuối tháng này, chúng tôi sẽ có một định dạng nhất quán để ghi lại các tuỳ chọn hiện có và mọi tuỳ chọn mới trong tương lai. Ngoài ra, định dạng này sẽ giúp bạn dễ dàng sử dụng hướng dẫn sử dụng TOR dưới dạng trang "man" trong tương lai.
- Trước tiên, hãy thêm nội dung mô tả ngắn gọn về từng danh mục tuỳ chọn, chẳng hạn như Tuỳ chọn máy chủ, Tuỳ chọn ứng dụng, v.v. Nội dung mô tả sẽ giúp người dùng biết những lựa chọn có thể có trong mỗi danh mục.
- Tạo một mẫu để xác định định dạng nhất quán cho việc ghi lại từng tuỳ chọn. Tôi đề xuất các phần/phần phụ sau đây được đưa vào mẫu.
- Tên: Tên của tuỳ chọn đang được ghi lại. Ví dụ: BandwidthBurst
- Tóm tắt: Tóm tắt cú pháp dòng lệnh của tuỳ chọn. Ví dụ: BandwidthBurst N byte
- Mô tả: Mô tả chức năng của tuỳ chọn cấu hình, giá trị mặc định. Ví dụ: Sử dụng tuỳ chọn này để giới hạn kích thước nhóm mã thông báo tối đa (còn gọi là busrt) về số byte đã cho theo mỗi hướng. Tuỳ chọn này mặc định là 1 GB.
- Giá trị tuỳ chọn: Liệt kê và mô tả các giá trị mà tuỳ chọn cho phép. Mô tả chi tiết về chức năng của từng giá trị và cách người dùng nhập các giá trị đó.
Tháng 3:
Hiện tại, có 9 nhóm/danh mục tuỳ chọn cấu hình. Để tăng khả năng tìm kiếm và làm tài liệu tham khảo nhanh, hãy tạo một trang chỉ mục liệt kê các tuỳ chọn cấu hình được sắp xếp theo thứ tự bảng chữ cái trong mỗi danh mục trong số 9 danh mục. Sau đó, bạn có thể sắp xếp các danh mục này theo mức độ ưu tiên sử dụng, trong đó các danh mục tuỳ chọn được sử dụng phổ biến nhất sẽ nằm ở trên cùng.
Sau 3 tháng, chúng tôi có thể xuất bản một Bản hướng dẫn TOR mới để người dùng tham khảo nhanh khi sửa đổi chế độ cài đặt cấu hình trong TOR.