Halaman ini berisi detail proyek penulisan teknis yang diterima untuk Google Season of Dokumen.
Ringkasan proyek
- Organisasi open source:
- Project Tor
- Penulis teknis:
- Sahabat Swati
- Nama proyek:
- Menulis ulang halaman panduan Tor
- Durasi proyek:
- Jangka panjang (5 bulan)
Project description
Setelah berdiskusi dengan mentor TOR untuk memahami apa ekspektasi mereka dari project ini, saya mengusulkan ide-ide berikut untuk membangun struktur dan format yang konsisten untuk halaman Manual TOR (https://2019.www.torproject.org/docs/tor-manual.html.en) untuk mengubahnya menjadi referensi cepat yang berguna bagi pengguna. Proyek ini akan selesai dalam waktu 3 bulan dan ide-ide berikut dipecah berdasarkan bulan.
Bulan ke-1:
Buat daftar isi untuk halaman ini. TOC ini akan mencakup topik ringkasan, dan judul dari 9 kategori opsi konfigurasi. Pada akhir bulan ini, para pengguna akan dapat mengakses berbagai kategori konfigurasi dengan mudah. TOC akan terlihat seperti ini:
- Overview – Tambahkan informasi tentang di mana TOR mempertahankan konfigurasi untuk kategori opsi yang berbeda, apakah semuanya ada di satu tempat, nama dan lokasi default file konfigurasi, aturan penggunaan opsi perintah, dan bagaimana pengguna dapat memodifikasi opsi ini. (Kami dapat menyertakan informasi dari teks pendahuluan pada topik CONFIGURATION FILE FORMAT).
- Opsi Umum
- Opsi Klien
- Opsi Server
- Opsi Server Direktori
- Menguji Opsi Jaringan
- Opsi Mitigasi Denial of Service
- Opsi Server Otoritas Direktori
- Opsi Layanan Tersembunyi
- Opsi Non-Persisten
Bulan ke-2:
Tujuan halaman manual adalah untuk menjawab pertanyaan tentang fungsi setiap opsi dan cara kerjanya dengan cepat. Saat ini, opsi tersebut tidak didokumentasikan dalam format terstruktur dan informasi tentang setiap opsi disajikan dalam paragraf yang menyulitkan pengguna untuk menemukan informasi dengan cepat. Semua informasi yang ada tentang opsi perlu diatur ulang menggunakan template. Pada akhir bulan ini, kami akan memiliki format yang konsisten untuk mendokumentasikan opsi yang ada dan opsi baru di masa mendatang. Selain itu, format ini akan memudahkan penggunaan manual TOR sebagai halaman 'man' di masa mendatang.
- Pertama, tambahkan deskripsi singkat tentang setiap kategori opsi, seperti Opsi Server, Opsi Klien, dan sebagainya. Deskripsi akan membantu pengguna mengetahui opsi yang diharapkan pada setiap kategori.
- Buat {i>template<i} untuk menentukan format yang konsisten untuk mendokumentasikan setiap opsi. Saya mengusulkan bagian/subbagian berikut untuk disertakan dalam template.
- Name: Nama opsi yang didokumentasikan. Contoh: Bursa Bandwidth
- Sinopsis: Ringkasan tampilan sintaksis command line dari opsi tersebut. Contoh: Bursa Bandwidth N byte
- Deskripsi: Jelaskan fungsi opsi konfigurasi dan nilai defaultnya. Contoh: Gunakan opsi ini untuk membatasi ukuran bucket token maksimum, yang juga dikenal sebagai busrt, ke jumlah byte yang ditentukan di setiap arah. Secara default, opsi ini disetel ke 1 Gbyte.
- Nilai opsi: Cantumkan dan jelaskan nilai yang diizinkan oleh opsi. Jelaskan secara mendetail fungsi dari setiap nilai dan bagaimana pengguna harus memasukkan nilai tersebut.
Bulan ke-3:
Saat ini, ada 9 grup/kategori opsi konfigurasi. Untuk meningkatkan kemudahan penelusuran dan sebagai referensi cepat, buat halaman indeks yang mencantumkan opsi konfigurasi yang diurutkan menurut abjad dalam masing-masing dari 9 kategori. Kategori ini kemudian dapat diurutkan berdasarkan prioritas penggunaannya, yaitu kategori opsi yang paling umum digunakan yang berada di atas.
Setelah 3 bulan, kami dapat menghasilkan Manual TOR refurbished yang dapat digunakan sebagai referensi cepat oleh pengguna untuk mengubah setelan konfigurasi di TOR.