פרויקט DIPY

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

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

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

DIPY

כתב טכני:

ארישה טאריק

שם הפרויקט:

ארגון מחדש ברמה גבוהה והתמקדות במשתמשי הקצה

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

אורך רגיל (3 חודשים)

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

אני מהנדס תוכנה ויש לי מומחיות בכתיבה טכנית. יש לי יותר מ-4 שנות ניסיון בכתיבת מסמכי תוכנה, מדריכים למשתמש, מדריכים ותיאורי פרויקטים באיכות גבוהה. אני גר באסלמבאד, פקיסטן (אזור זמן: UTC + 5). אני עובד/ת כמומחה/ת ב-Outliney שיימשך עד 18 באוגוסט. השתתפתי בעונה של Google ככתיבה טכנית בארגון OpenELIS Global. התיעוד המקורי היה בצרפתית, מוגבל ומיושן, לכן יצרתי תיעוד מקיף ומעודכן למשתמשי קצה באנגלית. נבחרתי ב-Outliney בארגון Perl ו-Raku לסביבות מאי עד אוגוסט 2020 כמפתח/ת קצה עורפי של שרת עובדות על מזון פתוח. מלבד פיתוח קצה עורפי, אחת המשימות העיקריות של ההתמחות הזו היא ליצור תיעוד למודולים ולפונקציות בפורמט POD. בשנה שעברה יצאתי לעולם הקוד הפתוח כשתרמתי כמה פרויקטים של קוד פתוח ואחר כך השתתפתי בעונה של Google Docs. והשנה נבחרתי ב-Interactiony שתומך במגוון תרבותי בקוד פתוח ובתוכנות חינמיות. יש לי אחיזה טובה בקשר ל-Git כי הפרויקט שלי ב-GitHub מתארח ב-GitHub, ומאז מרץ תרמו באופן קבוע ל-Open Food Facts ול-Mozilla Fenix. אני משתמש/ת Linux ב-3 השנים האחרונות ומאז אני משתמשת בפקודות טרמינל.

כלי התיעוד ושפות התיעוד שבהם השתמשתי הם Sphinx, Read the Docs, Markdown. אהבתי את הרעיון הזה ואני רוצה לעבוד עליו מפני שיש לי ניסיון רלוונטי ואשמח להשתמש בידע ובכישורים שלי כדי לתרום ל-DIPY. יש לי ניסיון בתחום של עיבוד תמונות דיגיטליות, ראייה ממוחשבת, למידת מכונה. המאמר הזה יעזור לי להבין טוב יותר את תהליך ההדמייה המוחלטת ולעזור לי ליצור מסמכים. יש לי ניסיון נרחב בתחום הרפואי. פיתחתי אתר רפואי לרופאים, מטופלים, מעבדות, נהגי אמבולנסים. עבדתי על מערכת אחרת ששימשה רופאים, מטופלים, אחיות, יועצים וחוקרים. זה יעזור לי ליצור מסמכים שהקהל יבין אותם בקלות.

עברתי על המסמכים של DIPY וראיתי כמה פגמים בתיעוד. יש כמה פרצות בתיעוד שאני מתכנן לשפר. מצב התיעוד הנוכחי: למסמכים חסרים מבנה ועיצוב ספציפיים הניווט עלול להיות מעייף וגוזל זמן, במיוחד עבור המשתמשים החדשים משתמשים מתקשים לקבל מידע מהמדריך תוכן התיעוד טעון שיפור כמשתמש חדש, גיליתי שקשה לי לגשת למדריך למשתמש ולמדריך למפתחים. יש לעצב את התיעוד מחדש כך שהמידע הנדרש על ידי המשתמש יהיה נגיש בקלות אין עקביות במסמכים

אני מתכנן לבצע את הפעולות הבאות:

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

מדריך למשתמש:

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

מדריך למפתחים:

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

TEMPLATE

זו אחת מהתבניות שבהן אפשר להשתמש במדריך לתרומות. אפשר לשנות אותו ולהוסיף או להסיר מקטעים בהתאם לדרישות המסמך.

תרומה ל-DIPY

• מכתב ברכה

TOC

קוד ההתנהגות

• הסטנדרטים שלנו
• דוגמאות להתנהגות שתורמת ליצירת סביבה חיובית
• דוגמאות להתנהגות לא מקובלת של המשתתפים
• תחומי האחריות שלנו
• תחומי האחריות של מתחזקי הפרויקט
• היקף

היקף קוד ההתנהגות

מה עליי לדעת כדי לעזור?

אם אתם רוצים לעזור בתרומת קוד בפרויקט שלנו, אנחנו משתמשים ב[כאן יש לציין את רשימת שפות התכנות, המסגרות או הכלים שהפרויקט שלך משתמש בהם]. אם עדיין לא מתאים לך לתרום את הקוד, אין בעיה! תוכלו גם לעיין בבעיות בתיעוד [link to the docs label or tag on your issue tracker] או את בעיות העיצוב שיש לנו [link todesign label or tag on a issue tracker if your project tracking issues of your project]. אם אתם רוצים לתרום קוד ורוצים לקבל מידע נוסף על הטכנולוגיות שבהן אנחנו משתמשים, אתם יכולים לעיין ברשימה שבהמשך. כדאי לכלול רשימה עם תבליטים של משאבים (מדריכים, סרטונים, ספרים) שתורמים חדשים יכולים להשתמש בהם כדי להבין מה המשתמשים צריכים לדעת כדי לתרום לפרויקט.

הגדרת סביבת הפיתוח

בקטע הזה אוסיף את הליך ההתקנה ואת יחסי התלות שצריך להתקין. כדי להתקין את $project, מריצים את: Setup project

• קוד מקור: github.com/$project/$project
• מעקב אחר בעיות: github.com/$project/$project/issues

איך מוסיפים תוכן

איך מדווחים על באג

• לפני שליחת דוח על באג
• איך שולחים דוח על באג (טוב)?

איך שולחים שינויים

• שליפת פרוטוקולים של בקשות
• תשובה מהצוות
• מהירות התגובה

איך מבקשים שיפור

• לפני שליחת הצעה לשיפור
• איך ניתן לשלוח הצעה (טובה) לשיפור?

תרומת הקוד הראשונה שלך

• בעיות למתחילים
• בעיות אפשריות #### משיכה של בקשות
• תהליך היצירה של בקשת משיכה
• מוודאים שכל בדיקות הסטטוס עוברות.

מה קורה אם בדיקות הסטטוס נכשלות?

• מבחני כתיבה
• כיסוי לבדיקה

מדריכי סגנון

• הודעות Git שמירה
• סגנון רגיל

תמיכה

אם נתקלת בבעיות, אפשר לפנות אלינו. אם דרושה לך עזרה, אפשר לשאול שאלות ברשימת הדיוור שלנו שנמצאת בכתובת: [e-mail] , IRC chat או [רשימת כל פלטפורמות תקשורת אחרות שבהן נעשה שימוש בפרויקט].

רישיון

בקטע הזה מפורט מידע על הרישיון של הפרויקט.

מחויבות בזמן ותקשורת:

אתן יותר מ-45 שעות בשבוע, אבל במקרה של תקלה, אפצות על השעות האלה בסופי שבוע. במהלך התקופה של הקשר בין הקהילה, אדבר על אמצעי התקשורת, ואסכם את הפגישות השבועיות, האמצעים והזמן לפגישות עם המנטור שלי. אעדכן את המנטור שלי לגבי עבודתי; אשתף את פרטי העבודה שלי באימייל למנטור שלי. אני רוצה להשתמש ב-TeamViewer לתקשורת כי הוא קל לשימוש עם הרבה פיצ'רים, כמו שיתוף מסכים וכו'.