בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- OpenMRS
- כותבים טכניים:
- Rainbow
- שם הפרויקט:
- שיפור מסמכי התיעוד הטכניים של OpenMRS למפתחים חדשים
- אורך הפרויקט:
- אורך סטנדרטי (3 חודשים)
תיאור הפרויקט
ההסבר
בזמן שהעולם סובל מההשלכות של מגפת הקורונה, ברור עוד יותר שמערכת תיעוד רפואי בקוד פתוח כמו OpenMRS יכולה להיות חלק מהפתרון למשבר כזה. כדי לעזור למפתחים חדשים לנווט בסביבה העסקית של OpenMRS, לקצר את תהליך ההצטרפות שלהם ולאפשר ליותר אנשים חדשים לתרום במהירות לפיתוח של OpenMRS, יש צורך במסמכי עזרה תמציתיים, ברורים ועדכניים. יש שני מסמכים קיימים למפתחים חדשים: • תחילת העבודה בתור מפתחים • מדריך למפתחים עם זאת, חלק מהתוכן לא עדכני והפורמט צריך שיפור. מטרת הפרויקט היא לעדכן את התוכן ולשפר את הפורמט של שני המסמכים האלה כדי שהם יהיו ידידותיים יותר למשתמש.
היקף
- צריך לארגן מחדש את התוכן של שני המסמכים האלה ולשנות את הפורמט שלו. במסמך 'תחילת העבודה כמפתחים': א. כדאי לפצל את 17 השלבים בהוראות לקטעים, כך שכל קטע יכיל פחות שלבים, כדי שיהיה קל יותר למשתמש לפעול לפי ההוראות. ב. לשנות את סדר השלבים. אפשר לשלב בין חלק מהשלבים. ג. מציינים בטבלאות קישורים לדפי wiki אחרים, כדי שההוראות יהיו תמציתיות וקריאות יותר.
במדריך למפתחים: א. אפשר לקצר את המידע על הרקע של OpenMRS שבפרקים הראשונים, ולהפנות את המשתמשים לדף OpenMRS.org כדי לקבל פרטים נוספים. ב. צריך להעביר את הפרק 'הגדרה' לפני הפרק 'תהליך הפיתוח'
מעדכנים את התוכן. למסמך 'תחילת העבודה כמפתח': א. עדכון ההגדרה של הסביבה ל-Linux ול-Windows (הצגת Docker) ב. עדכון ההגדרות של סביבת הפיתוח המשולבת (IDE) ל-IntelliJ ול-Eclipse. קישור למדריך למפתחים או למדריך למפתחים, לפי הצורך. ד. מוודאים שכל התכנים שמקושרים אליהם מעודכנים.
במדריך למפתחים: א. להציג את תהליך העבודה בפיתוח. ב. להסביר איך צוותי הפיתוח מאורגנים, איך חברי הצוות עובדים יחד, להוסיף קישורים לפגישות צוות ולדיונים בצוות, לעזור למפתחים חדשים למצוא את הצוותים שהם רוצים להצטרף אליהם. ג. מוסיפים את Docker בקטע 'הגדרת המערכת'. ד. מוסיפים פרטים נוספים על סוגים שונים של מודולים (מודול של אפליקציית עזר, מודול OWA ומודול פלטפורמה), ואיך הם פועלים יחד. ה. מוסיפים דוגמאות פשוטות לקודים כדי להראות איך כל סוג של מודולים נוצר ומופעל. f. מוסיפים דוגמאות פשוטות לבדיקה לכל סוג של מודול.
ניתוח קהלים
הקוראים המיועדים למאמר 'תחילת העבודה כמפתחים' ולמדריך למפתחים הם מפתחים שיש להם ידע מועט או לא ידוע ב-OpenMRS. קיימים שני סוגים של מפתחים: הסוג הראשון של הקהל הוא מפתחים זוטרים עם מעט ניסיון בפיתוח תוכנה, אם בכלל. לדוגמה, תלמידים בתוכנית GSoC שמחפשים פרויקטים בעולם האמיתי כדי ללמוד על פיתוח תוכנות בקוד פתוח. למפתחים האלה, שני המסמכים אמורים לספק מספיק פרטים והפניות כדי שיוכלו להתחיל למלא את הפערים בידע ולהתחיל לתרום לפרויקטים של OpenMRS תוך פרק זמן קצר יחסית. היעדים העיקריים של מפתחים זוטרים הם: 1. להבין את המיומנויות הנדרשות כדי להשתתף ב-OpenMRS (MySQL, Java Spring). React.js, Git וכו') ולמצוא את המשאבים ללמידת המיומנויות האלה. 2. הצטרפות לקהילה של OpenMRS, לימוד הכלים לתקשורת. 3. הגדרת הסביבה ו-IDE. 4. מתקינים את OpenMRS SDK. 5. להבין את תהליך העבודה בפיתוח. 6. יצירת קוד פשוט ליצירת מודולים חדשים. 7. פריסת מודולים חדשים שנוצרו. 8. בדיקת המודולים. 9. להשתמש ב-Git כדי לשלוח בקשות משיכה. הסוג השני של קהל היעד הוא מפתחים ברמה בינונית או מפתחים בכירים שרוצים להתאים אישית את OpenMRS בהתאם לצרכים של הארגון שלהם או לתרום ל-OpenMRS. למפתחים מנוסים יותר, שני המסמכים אמורים לספק סקירה כללית על OpenMRS ולשמש כמדריך להפניה לפרטים טכנולוגיים מעמיקים יותר במדריך למפתחים ובמקורות מידע אחרים. היעדים העיקריים למפתחים מנוסים הם: 1. הבנת מודל הנתונים והארכיטקטורה של OpenMRS 2. הצטרפות לקהילה של OpenMRS, לימוד הכלים לתקשורת. 3. קישורים למאגרי הקוד של OpenMRS. 4. מקורות מידע מעמיקים יותר.
תוכנית הפרויקט
שלב התכנון: • שיפור היעדים שהוגדרו בקטע 'היקף' • זיהוי תכנים מיושנים • יצירת קווים כלליים של שני המסמכים • הצגת המתאר בפני החונכים והמומחים לנושא (SME) • עדכון תוכנית הפרויקט
שלב פיתוח התוכן • לומדים על Docker, עוברים על כל שלבי ההתקנה ויוצרים קוד לדוגמה/קוד בדיקה פשוט • מראיינים מומחים בתחום כדי לשאול שאלות • מפתחים את הטיוטה הראשונה של שני המסמכים
בדיקה ופרסום של תוכן • עריכה עצמית של התוכן • שליחת הטיוטות שהושלמו לבודקים (חונך ו-SMEs) ולמשתמשי קצה לקבלת משוב • תיקון הטיוטה • מפרסמים את שני המסמכים בדף ה-wiki של OpenMRS. • כתיבת דוח פרויקט
עבודה מוקדמת
עבדתי קצת על הגדרת סביבת הפיתוח במערכת Linux ועל הגדרת OpenMRS SDK. אני בתהליך הגדרת IDE. אמשיך לעבוד על פיתוח מודולים פשוטים וכתיבה של קוד בדיקה.
הפניות ודיונים
https://talk.openmrs.org/t/breaking-down-walls-and-attracting-more-devs-to-openmrs/28502 https://talk.openmrs.org/t/openmrs-course-on-udemy-for-new-developer-learner/18861/14 https://talk.openmrs.org/t/looking-for-a-mentor-for-gsod2020-project-improving-documentation-for-new-developers/28999 https://talk.openmrs.org/t/a-possible-new-gsod-2020-project/28947