Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Tor Project
- Penulis teknis:
- Swati Thacker
- Nama proyek:
- Menulis ulang halaman manual Tor
- Durasi project:
- Berjalan lama (5 bulan)
Project description
Setelah berdiskusi dengan mentor TOR untuk memahami ekspektasi mereka dari project ini, saya mengusulkan ide berikut untuk menetapkan struktur dan format yang konsisten untuk halaman Manual TOR (https://2019.www.torproject.org/docs/tor-manual.html.en) agar dapat mengubahnya menjadi referensi cepat yang berguna bagi pengguna. Proyek ini akan selesai dalam 3 bulan dan ide-ide berikut diperinci berdasarkan bulan.
Bulan ke-1:
Buat daftar isi untuk halaman ini. Daftar isi akan menyertakan topik ringkasan, dan judul dari semua 9 kategori opsi konfigurasi. Pada akhir bulan ini, pengguna akan dapat membuka berbagai kategori konfigurasi dengan mudah. TOC akan terlihat seperti ini:
- Ringkasan – Menambahkan informasi tentang tempat TOR menyimpan konfigurasi untuk berbagai kategori opsi ini, jika semuanya berada di tempat yang sama, nama dan lokasi default file konfigurasi, aturan untuk menggunakan opsi perintah, dan cara pengguna mengubah opsi ini. (Kita dapat menyertakan informasi dari teks pengantar di bawah topik FORMAT FILE KONFIGURASI).
- 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 harus menjawab pertanyaan tentang fungsi dan cara kerja setiap opsi dengan cepat. Saat ini, opsi tidak didokumentasikan dalam format terstruktur dan informasi tentang setiap opsi disajikan dalam paragraf yang menyulitkan untuk menemukan informasi secara sekilas. 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 apa pun di masa mendatang. Selain itu, format ini akan memudahkan manual TOR digunakan sebagai halaman 'man' di masa mendatang.
- Pertama, tambahkan deskripsi singkat tentang setiap kategori opsi, seperti Opsi Server, Opsi Klien, dan sebagainya. Deskripsi ini akan membantu pengguna mengetahui opsi yang akan muncul di setiap kategori.
- Buat template untuk menentukan format yang konsisten guna mendokumentasikan setiap opsi. Saya mengusulkan bagian/subbagian berikut untuk disertakan dalam template.
- Nama: Nama opsi yang sedang didokumentasikan. Contoh: BandwidthBurst
- Sinopsis: Ringkasan tampilan sintaksis command line opsi. Contoh: BandwidthBurst 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 diberikan di setiap arah. Opsi ini ditetapkan secara default ke 1 Gbyte.
- Nilai opsi: Cantumkan dan jelaskan nilai yang diizinkan oleh opsi. Jelaskan secara mendetail apa yang dilakukan 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 ke-9 kategori tersebut. Kategori ini dapat diurutkan berdasarkan prioritas penggunaannya, kategori opsi yang paling umum digunakan berada di bagian atas.
Pada akhir 3 bulan, kami dapat menghasilkan Manual TOR yang diperbarui yang dapat digunakan sebagai referensi cepat oleh pengguna untuk mengubah setelan konfigurasi di TOR.