פרויקט של תשתית מהדר של LLVM

בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.

סיכום הפרויקט

ארגון קוד פתוח:

תשתית מהדר של LLVM

כותבים טכניים:

DR87

שם הפרויקט:

לבנות מחדש את אינדקס התיעוד של LLVM ומדריך הסגנון לתיעוד

אורך הפרויקט:

אורך סטנדרטי (3 חודשים)

תיאור הפרויקט

הפרויקט הזה כולל את המשימות הבאות:

a.) יש לשנות את המבנה של דף האינדקס של המסמכים כדי לספק חוויה ידידותית יותר למשתמש. המשימה הזו תכלול הערכה של הדף הנוכחי וסידור שלו מחדש על סמך שילוב של מחקר עצמאי, ראיונות עם עסקים קטנים ובינוניים ומשוב ממשתמשים. אפשרויות אפשריות כוללות שינוי התיאורים הקצרים, שינוי המבנה של הדף הקיים או הוספת שכבות (דפים) נוספות באמצעות מודל חשיפת מידע מסוג Progressive. האפשרות השנייה תפחית את מספר הקישורים בדף הראשי של המדד כדי שיהיה קל יותר למשתמשים לאתר מידע או מדריכים ספציפיים. לדוגמה, המדד עשוי לכלול קישורים לדפים נפרדים של עיצוב LLVM וסקירה כללית, מדריכים למשתמש, מסמכי עזרה של רכיבי משנה ומסמכי עזרה של תהליך הפיתוח.

b.) עדכון מדריך הסגנון של LLVM Sphinx לתורמים בקוד פתוח. המשימה הזו תכלול הערכה של המדריך הנוכחי, זיהוי פערים באמצעות מחקר עצמאי וריאיונות עם מומחים בתחום, ועדכון המדריך על סמך הדרישות המוסכמות. העדכונים יכולים לכלול ארגון מחדש של פריסת המדריך, הוספת תוכן חדש והוספה של קישורים לדפים רלוונטיים, כמו המדריך התורם. המטרה הסופית היא להקל על המתנדבים להתחיל לתרום בהקדם האפשרי.