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