דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- HPX
- כתב טכני:
- rstobaugh
- שם הפרויקט:
- עריכה וייעול של מסמכי תיעוד קיימים בנושא HPX
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
ההצעה שלי היא לערוך ולייעל את התוכן של מסמכי התיעוד הקיימים של HPX. ההצעה שלי היא לפרויקט לתקופה סטנדרטית (שלושה חודשים) שמתמקד בתיקון שני פרקים מהמדריך של קבוצת STE||AR: " "HPX Build System and Launching"" (1) ו-"הגדרת אפליקציות HPX" (2).
בפרק בנושא "מערכת HPX Build and Launching" יש כמה שגיאות דקדוק, וגם ניסוח מבלבל ושימוש לא עקבי באותיות רישיות במונחים כמו"CMake". בנוסף, הוא מכיל מידע חוזר, שבכוונתי לארגן מחדש, לאחד ולקצר לפי הצורך. למרות שהפרק לגבי 'הגדרת אפליקציות HPX' כולל גם כמה שגיאות דקדוק שדורשות טיפול, הדבר החשוב ביותר לגבי הפרק הזה הוא הידידותיות שלי למשתמש. בפרק יש שלוש בעיות עיקריות לגבי עיצוב שברצוני להתייחס אליהן:
חלק מהכותרות קבורות בתוך הטקסט, ולכן קשה ברפרוף בפרק. בשלב זה, המשתמש צריך לקרוא בקפידה את המדריך כדי להבין את המטרה של כל טבלה. זו לא האינטראקציה של רוב המשתמשים עם ספרי הדרכה, במיוחד אם הם כבר קראו את התוכן בעבר. במקום זאת, אני מתכוון לוודא שלכל טבלה יש כותרת ברורה וייחודית, שאותה ניתן לראות בקלות אם המשתמש גולל בטקסט.
כשרושמים נכסים שונים תחת כותרת מסוימת, סדר הנכסים לא מופיע לפי סדר לוגי. הנכסים מקובצים יחד לפי נושא משותף, אבל אין קבוצות משנה שגורמות למידע מבוזר. לדוגמה, משתמש עשוי להיתקל בכמה נכסים שעוסקים ברשות מוניציפאלית, בכמה נכסים שעוסקים בנושא אחר, ובאחרים על נכסים אחרים שעוסקים ברשויות מוניציאליות. היעדר מבנה פנימי מתחת לכותרות מקשה על איתור כל המידע בנושא משנה ספציפי. לכן, אני מתכנן לארגן מחדש כמה מהתרשימים כדי לקבץ מידע דומה בצורה ברורה יותר בכל כותרת.
המשתמשים נאלצים לנווט קדימה ואחורה בין הקטעים (או לפתוח את המדריך בשתי כרטיסיות נפרדות) כדי להבין הוראות מסוימות בצורה מלאה. יש נקודות שבהן הפרק מפנה את המשתמשים למשפט אחד בקטע הקודם באופן שמאלץ את הקורא לגלול למעלה או ללחוץ על היפר-קישור כדי להבין את ההוראה המדויקת, כי המדריך כולל שפה עמומה כמו "השלב הזה נוצר אחרי שלב 11" בסעיף הקודם. השיטה הזו אכן מבטלת חזרות, אבל היא מקשה על הבנת ההוראות, כי אלה משימות שצריך לבצע לפי סדר מסוים. במקום זאת, אני מציע ניסוח ספציפי יותר כדי שהמשתמשים לא יצטרכו להפריע לתהליך הקריאה שלהם על ידי מעבר בין קטעים או מסמכים.
אם אשלים את הקטעים האלה לפני שציר הזמן הסטנדרטי יסתיים, אני רוצה גם לנקות את הדף 'למה כדאי להשתמש ב-HPX?' (3) במסמכי התיעוד למשתמש של קבוצת STE||AR. בדף הזה יש תוכן מבוא שחוזר על עצמו, ואני מקווה לאחד אותו. הוא מכיל חוסר עקביות באותיות רישיות (במיוחד בז'רגון) ובקול, כדי ליצור תחושה לא אחידה. המטרה שלי היא ליצור מבוא מאוחד ועקבי יותר לעבודה של קבוצת ה-STE||AR.