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