דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- OpenMRS
- כתב טכני:
- קשת
- שם הפרויקט:
- שיפור המסמכים הטכניים של OpenMRS למפתחים חדשים
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
פירוט הנימוקים
מאחר שהעולם סובל מההשלכות של מגיפת נגיף הקורונה (COVID-19), ברור עוד יותר שמערכת קוד פתוח לתיעוד רפואי, כמו OpenMRS, יכולה להיות חלק מהפתרון במקרה של משבר כזה. כדי לעזור למפתחים החדשים לנווט בסביבה העסקית של OpenMRS, לקצר את תהליך הקליטה שלהם ולאפשר למשתתפים חדשים לתרום במהירות לפיתוח של OpenMRS, חשוב שיהיה לך תיעוד תמציתי, ברור ועדכני. קיימים שני מסמכים למפתחים חדשים: • תחילת העבודה כמפתחים • מדריך למפתחים עם זאת, חלק מהתכנים מיושנים והפורמט טעון שיפור. מטרת הפרויקט היא לעדכן את התוכן ולשפר את הפורמט של שני המסמכים כדי שיהיו ידידותיים יותר למשתמש.
היקף
- מארגנים מחדש את התוכן של שני המסמכים האלה ומעצבים אותו מחדש. במסמך 'תחילת העבודה כמסמך למפתחים': א. מחלקים את 17 השלבים בהוראה לקטעים, כל אחד מהם מכיל פחות שלבים, כך שלמשתמשים קל יותר לעקוב אחרי השלבים. b. יש לשנות את סדר השלבים. חלק מהשלבים אפשר לשלב. ג. הצגת רשימה של קישורים לדפי wiki אחרים בטבלאות, כדי שההוראות יהיו תמציתיות וקריאות יותר.
במדריך למפתחים: א. ניתן לקצר את פרטי הרקע של OpenMRS בפרקים הראשונים, להפנות את המשתמשים לדף OpenMRS.org כדי לקבל פרטים נוספים. b. צריך להעביר את פרק ההגדרה למעלה לפני הפרק 'תהליך הפיתוח'
מעדכנים את התוכן. במסמך 'תחילת העבודה כמסמך למפתחים': א. עדכון סביבת הגדרה עבור Linux ו-Windows (Introduce Docker) ב. עדכון ההגדרה של סביבת פיתוח משולבת (IDE) ל-IntelliJ ול-Eclipse ג. קישור למדריך למפתחים או למדריך למפתחים, היכן שרלוונטי. ד. יש לוודא שכל התוכן של הקישור לאתר עדכני.
במדריך למפתחים: א. מציגים את תהליך העבודה של הפיתוח. ב. הציגו איך צוותי הפיתוח מאורגנים, איך חברי הצוות עובדים יחד, הוסיפו קישורים לישיבת צוות, דיונים בצוות ועזרו למפתחים חדשים למצוא את הצוותים שכדאי להצטרף אליהם. ג. מוסיפים את Docker בפרק של הגדרת המערכת. ד. צריך להוסיף עוד פרטים על סוגים שונים של מודולים (מידע על מודול האפליקציה, מודול OWA ומודול פלטפורמה), איך הם עובדים יחד. למשל, מוסיפים קודים פשוטים לדוגמה כדי להמחיש את אופן היצירה והפריסה של כל סוג של מודולים. ו. מוסיפים דוגמאות פשוטות לבדיקה לכל סוג של מודול.
ניתוח קהלים
היעדים של 'תחילת העבודה כמפתחים' ושל המדריך למפתחים הם מפתחים בעלי ידע מועט, אם בכלל, ב-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. אפשר למצוא מקורות מידע מפורטים נוספים.
תוכנית הפרויקט
שלב התכנון: • שיפור היעדים שהוגדרו בקטע 'היקף' • זיהוי תכנים מיושנים • הפקת קווי מתאר לשני המסמכים • הצגת המתאר למנטור ולמומחים לנושאי התוכן (SMEs) • עדכון של תוכנית הפרויקט
שלב פיתוח התוכן • לומדים את 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-udmy-for-new-developer-learner/18861/14 https://Talk.openmrsing-9odaodaible/