Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.
Proje özeti
- Açık kaynak kuruluşu:
- Tor Project
- Teknik yazar:
- Swati Thacker
- Proje adı:
- Tor manuel sayfasını yeniden yazma
- Proje uzunluğu:
- Uzun süreli (5 ay)
Proje açıklaması
Bu projeden beklentilerinin ne olduğunu anlamak üzere TOR mentorlarla yaptığımız görüşmeden sonra, TOR Kılavuzu sayfasını (https://2019.www.torproject.org/docs/tor-manual.html.en) tutarlı bir yapı ve biçim oluşturmak için aşağıdaki fikirlerden yararlanıp bu sayfayı kullanıcılar için kullanışlı ve hızlı bir başvuru kaynağına dönüştürmenizi öneririm. Bu proje 3 ayda tamamlanacak. Aşağıdaki fikirler aya göre ayrılmıştır.
1. ay:
Bu sayfa için bir içindekiler tablosu oluşturun. İçerik dizini, genel bakış konusunu ve yapılandırma seçeneklerinin 9 kategorisinin tüm başlıkları içerir. Bu ayın sonuna kadar kullanıcılar, farklı yapılandırma kategorilerine parmak uçlarıyla gidebilecek. İçindekiler listesi şöyle görünür:
- Genel Bakış – TOR'un bu farklı seçenek kategorilerinin yapılandırmasını nerede tuttuğu, bunların hepsinin aynı yerde olup olmadığı, yapılandırma dosyasının adını ve varsayılan konumunu, komut seçeneklerini kullanmaya ilişkin kuralları ve kullanıcıların bu seçenekleri nasıl değiştirebileceği hakkında bilgi ekleyin. (Giriş metnindeki bilgileri YAPILANDIRMA DOSYASI BİÇİMİ konusuna dahil edebiliriz).
- Genel Seçenekler
- İstemci Seçenekleri
- Sunucu Seçenekleri
- Dizin Sunucusu Seçenekleri
- Ağ seçeneklerini test etme
- Hizmet Reddi Saldırıları ile İlgili Çözümler
- Dizin Yetkilisi Sunucusu Seçenekleri
- Gizli Hizmet Seçenekleri
- Kalıcı Olmayan Seçenekler
2. Ay:
Kılavuz sayfasının amacı, her bir seçeneğin ne işe yaradığı ve nasıl çalıştığıyla ilgili soruları hızlıca yanıtlamak olmalıdır. Şu anda seçenekler yapılandırılmış bir biçimde belgelenmiyor ve her seçenekle ilgili bilgiler paragraflar halinde sunuluyor. Bu da bilgileri bir bakışta bulmanızı zorlaştırıyor. Seçeneklerle ilgili mevcut tüm bilgilerin bir şablon kullanılarak yeniden düzenlenmesi gerekir. Bu ayın sonuna kadar, mevcut seçenekleri ve gelecekte sunulacak yeni seçenekleri belgelemek için tutarlı bir biçime sahip olacağız. Ayrıca bu biçim, TOR kılavuzunun gelecekte "man" sayfaları olarak kullanılmasını kolaylaştıracaktır.
- Öncelikle her seçenek kategorisiyle ilgili kısa bir açıklama ekleyin (ör. sunucu seçenekleri, istemci seçenekleri vb.). Açıklamalar, kullanıcıların her kategoride hangi seçenekleri bulabileceklerini anlamalarına yardımcı olur.
- Her seçeneği belgelemek için tutarlı bir biçim tanımlamak üzere bir şablon oluşturun. Şablona aşağıdaki bölümlerin/alt bölümlerin eklenmesini öneriyorum.
- Ad: Belgelenen seçeneğin adı. Örnek: BandwidthBurst
- Özet: Seçeneğin komut satırı söz dizimine dair özet. Örnek: BandwidthBurst N bayt
- Açıklama: Yapılandırma seçeneğinin ne yaptığını ve varsayılan değerin ne olduğunu açıklayın. Örnek: Burst olarak da bilinen maksimum jeton paketi boyutunu her yönde belirtilen bayt sayısıyla sınırlamak için bu seçeneği kullanın. Bu seçenek varsayılan olarak 1 GB'tır.
- Seçenek değeri: Seçeneğin izin verdiği değerleri listeleyin ve açıklayın. Her bir değerin ne yaptığını ve kullanıcının bu değerleri nasıl girmesi gerektiğini ayrıntılı bir şekilde açıklayın.
3. ay:
Şu anda 9 yapılandırma seçeneği grubu/kategorisi vardır. Arama yapılabilirliği artırmak ve hızlı referans olarak kullanmak için 9 kategorinin her birinde yapılandırma seçeneklerini alfabetik olarak sıralayan bir dizin sayfası oluşturun. Bu kategoriler daha sonra kullanım önceliklerine göre sıralanabilir. En sık kullanılan seçenek kategorileri en üstte olur.
3 ayın sonunda, TOR'daki yapılandırma ayarlarını değiştirmek için kullanıcılar tarafından hızlı referans olarak kullanılabilecek yenilenmiş bir TOR Kılavuzu oluşturabiliriz.