דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- תשתית מהדר LLVM
- כתב טכני:
- DR87
- שם הפרויקט:
- שינוי המבנה של אינדקס מסמכי תיעוד של LLVM ומדריך סגנון לתיעוד
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
הפרויקט הזה כולל את המשימות הבאות:
a.) יש לשנות את המבנה של דף אינדקס המסמכים כדי לספק חוויה ידידותית יותר למשתמש. משימה זו תכלול הערכה של הדף הנוכחי ושינוי המבנה שלו על בסיס שילוב של מחקר בלתי תלוי, ראיונות עם עסקים קטנים ובינוניים ומשוב ממשתמשים. אפשרויות אפשריות כוללות שינוי התיאורים הקצרים, שינוי המבנה של הדף הקיים ו/או הוספת שכבות (דפים) באמצעות מודל חשיפה מתקדם של מידע. האפשרות הזו תפחית את מספר הקישורים בדף האינדקס הראשי, כדי להקל על המשתמשים לאתר מידע או מדריכים ספציפיים. לדוגמה, האינדקס עשוי לכלול קישורים לדפים נפרדים עבור עיצוב וסקירה כללית של LLVM, מדריכים למשתמש, תיעוד של מערכות משנה ומסמכי תיעוד של תהליכי פיתוח.
b.) עדכון מדריך הסגנון של LLVM Sphinx ליוצרי קוד פתוח. משימה זו תכלול הערכה של המדריך הנוכחי, זיהוי פערים באמצעות מחקרים עצמאיים וראיונות עם עסקים קטנים ובינוניים, ועדכון המדריך בהתאם לדרישות המוסכמות. העדכונים עשויים לכלול ארגון מחדש של פריסת המדריך, הוספת תוכן חדש והוספת קישורים לדפים רלוונטיים, כמו המדריך לתורמים. המטרה הסופית היא לעזור למתנדבים להתחיל לתרום במהירות האפשרית.