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ở:
- Tor Project
- Người viết nội dung kỹ thuật:
- Tàm swati
- Tên dự án:
- Viết lại trang hướng dẫn sử dụng 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 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 đây nhằm thiết lập một cấu trúc và định dạng nhất quán cho trang Hướng dẫn sử dụng 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 được chia nhỏ theo từng tháng.
Tháng 1:
Tạo mục lục cho trang này. Nội dung này sẽ bao gồm một chủ đề tổng quan và các tiêu đề của tất cả 9 danh mục lựa chọn cấu hình. Đến cuối tháng này, người dùng có thể dễ dàng di chuyển đến các danh mục cấu hình khác nhau. Spotify 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 cùng một lúc, tên và vị trí mặc định của tệp cấu hình, các 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ể thêm thông tin từ văn bản giới thiệu trong chủ đề ĐỊ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ủ
- Tuỳ chọn Máy chủ thư mục
- Kiểm tra các tuỳ chọn mạng
- Các biện pháp giảm thiểu từ chối dịch vụ
- Tuỳ chọn về máy chủ của cơ quan quản lý thư mục
- Các lựa chọn về dịch vụ bị ẩn
- Các tuỳ chọn không cố định
Tháng 2:
Mục đích của trang thủ công phải là giải đáp nhanh chóng các câu hỏi về chức năng và cách thức của mỗi tuỳ chọn. Hiện tại, các tuỳ chọn không được ghi lại theo định dạng có cấu trúc và thông tin về mỗi tuỳ chọn được trình bày trong các đoạn văn khiến việc tìm nhanh thông tin trở nên khó khăn. Tất cả thông tin hiện có về các tuỳ chọn cần được sắp xếp lại bằng mẫu. Đến 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 lựa chọn hiện tại và mọi lựa 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 làm trang dành cho "người đàn ông" trong tương lai.
- Trước tiên, hãy thêm mô tả ngắn gọn về mỗi danh mục tuỳ chọn, chẳng hạn như các 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 cho mỗi danh mục.
- Tạo một mẫu để xác định một định dạng nhất quán ghi lại từng lựa chọn. Tôi đề xuất đưa các phần/tiểu mục sau vào mẫu.
- Tên: Tên của tuỳ chọn đang được ghi lại. Ví dụ: Phạm vi băng thông
- Tóm tắt: Bản tóm tắt về cú pháp dòng lệnh của tuỳ chọn. Ví dụ: Phạm vi băng thông 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, là số byte nhất định theo mỗi hướng. Tuỳ chọn này mặc định là 1 Gbyte.
- 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 nên nhập các giá trị đó.
Tháng 3:
Hiện tại, có 9 nhóm/danh mục lựa chọn cấu hình. Để nâng cao khả năng tìm kiếm và để tham khảo nhanh, hãy tạo một trang chỉ mục liệt kê các lựa chọn cấu hình được sắp xếp theo thứ tự bảng chữ cái của từng danh mục trong số 9 danh mục. Sau đó, các danh mục này có thể được sắp xếp theo mức độ ưu tiên sử dụng, các danh mục tuỳ chọn thường dùng nhất nằm ở trên cùng.
Sau 3 tháng, chúng tôi có thể đưa ra Sổ tay hướng dẫn về TOR đã được tân trang để người dùng tham khảo khi cần sửa đổi các chế độ cài đặt cấu hình trong TOR.