בדף הזה מופיעים הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Docs ל-Google Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- פרויקט Tor
- כותבים טכניים:
- Swati Thacker
- שם הפרויקט:
- כתיבה מחדש של דף המדריך של Tor
- אורך הפרויקט:
- Long running (5 months)
תיאור הפרויקט
אחרי שיחה עם מנחי TOR כדי להבין מהן הציפיות שלהם מהפרויקט הזה, הצעתי את הרעיונות הבאים כדי ליצור מבנה פורמט עקבי לדף של מדריך TOR (https://2019.www.torproject.org/docs/tor-manual.html.en), כדי להפוך אותו למקור מידע שימושי ומהיר למשתמשים. הפרויקט הזה יושלם תוך 3 חודשים, והרעיונות הבאים מפורטים לפי חודש.
חודש 1:
אפשר ליצור תוכן עניינים לדף הזה. תוכן העניינים יכלול נושא סקירה כללית וכותרות של כל 9 הקטגוריות של אפשרויות ההגדרה. עד סוף החודש הזה, המשתמשים יוכלו לעבור בקצות האצבעות אל קטגוריות ההגדרות השונות. תוכן העניינים ייראה כך:
- סקירה כללית – הוספת מידע על המיקום שבו TOR שומר את התצורה של קטגוריות האפשרויות השונות, אם כולן מופיעות במקום אחד, את השם ומיקום ברירת המחדל של קובץ התצורה, את הכללים לשימוש באפשרויות הפקודות ואיך משתמשים יכולים לשנות את האפשרויות האלה. (אנחנו יכולים לכלול מידע מהטקסט המבוא בנושא 'פורמט קובץ התצורה').
- אפשרויות כלליות
- אפשרויות לקוח
- אפשרויות שרת
- אפשרויות של שרת גילוי
- בדיקת אפשרויות רשת
- אפשרויות למניעת מניעת שירות (DoS)
- אפשרויות שרת של רשות ספרייה
- אפשרויות שירות מוסתרות
- אפשרויות לא עמידות
חודש 2:
מטרת הדף של המדריך היא לענות במהירות על שאלות לגבי הפעולות של כל אפשרות ואופן הפעולה שלהן. נכון לעכשיו, האפשרויות לא מתועדות בפורמט מובנה, והמידע על כל אפשרות מוצג בפסקאות שמקשות עליכם למצוא מידע במבט חטוף. צריך לארגן מחדש את כל המידע הקיים על אפשרויות באמצעות תבנית. עד סוף החודש יהיה לנו פורמט עקבי לתיעוד האפשרויות הקיימות ולכל אפשרות חדשה בעתיד. בנוסף, הפורמט הזה יאפשר להשתמש במדריך TOR בקלות כקבצי 'man' בעתיד.
- ראשית, מוסיפים תיאור קצר לגבי כל קטגוריית אפשרויות, כגון 'אפשרויות שרת', 'אפשרויות לקוח' וכן הלאה. התיאורים יעזרו למשתמשים לדעת למה לצפות בכל קטגוריה.
- כדאי ליצור תבנית כדי להגדיר פורמט עקבי לתיעוד של כל אפשרות. אני מציע לכלול בתבנית את הקטעים או הקטעים המשניים הבאים.
- שם: השם של האפשרות שמתועדת. דוגמה: BandwidthBurst
- סיכום: סיכום של התחביר של האפשרות בשורת הפקודה. דוגמה: BandwidthBurst N bytes
- תיאור: תיאור הפעולה של אפשרות ההגדרה וערך ברירת המחדל שלה. דוגמה: אפשר להשתמש באפשרות הזו כדי להגביל את הגודל המקסימלי של קטגוריית האסימונים, שנקראת גם 'פרץ', למספר הבייטים שצוין בכל כיוון. ברירת המחדל של האפשרות הזו היא 1GB.
- ערך האפשרות: מציינים ומתארים את הערכים שהאפשרות מאפשרת. תארו בפירוט מה עושה כל ערך ואיך על המשתמש להזין את הערכים.
חודש 3:
נכון לעכשיו, יש 9 קבוצות/קטגוריות של אפשרויות הגדרה. כדי לשפר את יכולת החיפוש וכמקור מידע מהיר, כדאי ליצור דף אינדקס שבו מפורטות אפשרויות ההגדרה, ממוינות לפי סדר אלפביתי בכל אחת מ-9 הקטגוריות. לאחר מכן, אפשר לסדר את הקטגוריות האלה לפי סדר העדיפויות של השימוש, כך שקטגוריות האפשרויות הכי נפוצות הן בראש סדר העדיפויות.
בסיום 3 החודשים, נוכל ליצור מדריך מעודכן ל-TOR שמשמש כמקור מידע מהיר למשתמשים שרוצים לשנות את הגדרות התצורה ב-TOR.