דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- CERN-HSF
- כתב טכני:
- LuckInTheRain
- שם הפרויקט:
- מסמכי ROOT: ניתוח, שינוי מבני ושכתוב
- אורך הפרויקט:
- תקופה ארוכה (5 חודשים)
תיאור הפרויקט
הפרויקט מורכב מארבעה שלבים:
1) מנתח את התיעוד הנוכחי של ROOT
יש ניתוח ובדיקה של מסמך ה-ROOT המלא (אתר אינטרנט, מדריך למשתמשים, הפניות C++, מדריכים וכו') לפי הקריטריונים הבאים: המבנה, מודולריזציה, סטנדרטיזציה, מנגנוני גישה, עקביות, סוגי המידע שנעשה בהם שימוש, הכנה והבנה של קבוצות ספציפיות בהתאם לקבוצה. המטרה היא ליצור קונספט לניהול מידע, מטריצה לניהול מבנה וקו מנחה ליצירת האחדה של התוכן.
2.) הגדרת שיטה לבניית מסמכי תוכנה בכתב יחד עם צוות ROOT
DITA (Darwin Information Typing Architecture), תקן OASIS למסמכי תוכנה (https://www.oasis-open.org/committees/dita/) מוצג לצוות של ROOT. ההתמקדות העיקרית היא בהבנת האופן שבו ניתן לבנות תוכן ספציפי לתוכנה, וכיצד נעשה שימוש בסוגים של מידע בסיסי כ"קונספט", "משימה" ו"סימוכין" בכתיבת מסמכי תוכנה.
3.) בנייה מחדש וארגון מחדש של מסמכי ROOT
על סמך התוצאות של שני השלבים הראשונים, התיעוד של ROOT הוא מבנה מחדש ומודולרי בהתאם לקבוצות יעד, לתפקידים ולתרחישים לדוגמה, והתוכן מוקצה לרכיבים המתאימים (אתר אינטרנט, מדריך למשתמש, הפניה ל-C++ , מדריכים וכו') ולסוגי התוכן. מאחר שהמידע הזמין נרחב מאוד, יש גם ליצור מבנה הפניה עקבי. המטרה היא לספק סקירה כללית מקיפה ולהראות למשתמשים איך אפשר להשתמש ב-ROOT לצרכים שלהם. בנוסף, מוצג הקדמה קומפקטית שלא קשורה לפיזיקה.
4.) שכתוב של מסמכי התיעוד של ROOT
חלקים עיקריים בתיעוד, במיוחד המדריך למשתמש, משוכתבים בהתאם לגישת DITA. כללי הבנייה והכתיבה מתועדים במדריך סגנון כדי להבטיח עקביות במסמכים בעתיד. המטרה היא לאפשר לצוות ROOT להרחיב ולתחזק את מסמכי ה-ROOT בעצמם בעתיד.
לוח זמנים משוער (5 חודשים):
שלב 1: ניתוח תיעוד ה-ROOT הנוכחי: 3 שבועות.
שלב 2: הגדרת שיטה לבניית מסמכי תיעוד של תוכנה יחד עם צוות ROOT: שבועיים.
שלב 3: בנייה מחדש וארגון מחדש של מסמכי ה-ROOT: 4 שבועות.
שלב 4: שכתוב התיעוד של ROOT: 11 שבועות.