דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- קרן Cloud Native Computing Foundation (CNCF)
- כתב טכני:
- סיאם סונדאר ק'
- שם הפרויקט:
- דוגמאות נוספות וטובות יותר לקובקטל
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
מטרת הפרויקט היא לשפר את התקציר הקיים ואת מסמכי העזר בנושא.
אלה היעדים הסופיים של הפרויקט: • ליצור דוגמאות נוספות וטובות יותר לקובקטל. • הוסיפו דוגמאות קובקטל לתקציר של ה-kubectl. • ארגון מחדש של מסמכי kubectl להשגת יעילות מרבית.
יעד 1 - דוגמאות לקובקטל:
יעבוד בשיתוף פעולה הדוק עם קבוצות האינטרס המיוחדות ב-CLI כדי לקבל הקשר, אילו דוגמאות של משתמשי kubernetes יותר מעוניינים, ויתעדו את ההקשר. אפשר לבצע מגוון פעולות, החל משיפור פקודות ה-kubectl הקיימות בתקציר ועד להוספת פקודות חדשות לגיליון.
יעד 2 - יעילות מוגברת של המסמכים:
כדי שהמסמכים יהיו מועילים יותר, תוכלו לבצע את הפעולות הבאות:
• מניעת מאבקים מתחילים • סידור מחדש של פקודת ה-kubectl בסדר מסוים כדי להבטיח המשכיות בזרימה הלוגית
מניעת קשיים מתחילים בעזרת הסברים טובים יותר לפי תרחיש לדוגמה או פקודה. זה נשמע פשוט, אבל יכול להשפיע באופן משמעותי על משתמשים מתחילים להמשיך את הלמידה או להפסיק את הלמידה. לדוגמה, כשהתחלתי להשתמש ב-kubernetes דרך kubectl, לא ידעתי מה ההבדל בין pods ו-פריסות. בהתחלה פרסתי שירות לקצה העורפי שנכתב ב-Nonojs. לאחר מספר שעות רציתי להסיר את רצף התאים, לכן ניסיתי למחוק את רפידת המשבצות, אבל הרפודים נוצרו מחדש באופן עצמאי. הייתי מופתע למדי מה שקרה, ותהיתי למה המערכת משחזרת אותה ולא נמחקה. לאחר מספר חיפושים באינטרנט, גיליתי שמחיקת רצפי מודעות לא זהה למחיקה של פריסה. מי שמבחן את התהליך עשוי להיראות פשוט, אבל הסבר ברור שמבטל אי בהירות כזו הוא הדבר שמבדיל בין מסמך טוב למסמך מעולה.
סידור מחדש של פקודת ה-kubectl בסדר מסוים, כדי להבטיח את ההמשכיות בזרימה הלוגית. אם אתם מעדיפים כמוני לספר סיפורים, אתם בטח תוהים, איך אפשר להעביר אלמנטים של סיפור סיפורים לגיליון מסמכים שמכיל רשימה של פקודות טרמינל, לדעתי, אפשר לעשות את זה. לכל מה שאנחנו לומדים יש תמיד זרימה הגיונית - נקודת התחלה ונקודת סיום, אם תרצו. ל-Kubectl ככלי של שורת הפקודה יש כמובן עקומת למידה, למעשה עקומת הלמידה חופפת לעקומת הלמידה של Kubernetes עצמה. מכיוון שכמעט כולם מתחילים את המסע עם קוברנטה דרך קובקטל (מלבד האנשים שמשתמשים בממשק המשתמש באינטרנט) ומכיוון שעקומת הלמידה שלה משתלבת באופן הדוק עם עקומת הלמידה של ה-kubernets, ניתן לשפר את המסמכים באופן משמעותי על ידי שינוי הסדר של הפקודות האלו והצגת רכיבים לסיפורים. נגיד, למשל, שאפשר להסביר תכונות כמו התאמה אוטומטית של רצף תאים לרוחב אחרי הסברים על משאבים באמצעות דוגמאות ואיורים מהעולם האמיתי.
יעד 3 - שיפורים בנוחות השימוש ב-Docs:
המעבר שבוצע לאחרונה מאתר Kubernetes אל Docsy Hugo הוא שינוי נהדר מנקודת המבט של Docs. למרות שההעברה הצליחה, עדיין יש מקום לשיפור רב בפרסום המסמכים.
הנה כמה שינויים שאני מציע,
• גלילה אוטומטית בחלונית הימנית לקטע הפעיל הנוכחי במסמכים הראשיים - פעולה זו יכולה לעזור במעקב אחר הקטעים הנוכחיים, הקטעים הבאים והקטעים הקודמים. • העתקה ללוח – פקודות מסוימות יכולות להיות ארוכות, ופונקציית ההעתקה יכולה להיות שימושית כשעובדים עם פקודות כאלה. • עיצוב תוכן של קובצי מסמכים - לאחר ההעברה, התוכן בדפים מסוימים אינו מעוצב כראוי. למשל: הקטע 'סוג המשאב' בסקירה הכללית של ה-kubectl. זה פוגע בחוויית המשתמש.
השינויים האלה יכולים לשפר את חוויית המשתמש באתר של kubernetes, וגם לשפר את הפרודוקטיביות של המשתמשים.