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