שימוש ב-Kanban כדי לשפר את מסמכי ההנדסה ושיתוף הידע

הקדמה: מדוע תיעוד נכשל במהנדסי הנדסה

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

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

מהו Kanban? A Visual Workflow

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

מיצגים של מועצת קנבראן

• (ב) ,0) קולומנס: Define theשלבים של מחזור החיים של התיעוד שלך.שלבים נפוצים כוללים "Backlog", "Drafting", "תזכיר", "Published", "Archive".
• (ב) ⁇ :0) ,(ה) , כל כרטיס מייצג משימה ספציפית של תיעוד.כרטיסים צריכים לכלול כותרת, תיאור, נספח, תאריך מראש ועדיפות.
• (FLT:0Swimlanes:FLT:1orital Paths) יכול להפריד סוגים של תיעוד (למשל, API docs, מדריכי משתמשים, חוברות ריצה פנימיות).
• (ב) §0WIP Limits: 1:1 מספר מקסימלי של קלפים מותר בעמודה אחת בכל עת.זה מונע צווארי בקבוק ומעודד השלמת לפני תחילת העבודה החדשה.

(ב) ניתן לראות את הפאנלים (הלבן עם רשימות מקלות) או דיגיטלית (דברים כמו FLT:0) ;0) ,TrelloFLT:1, FLT:2JirairveFLT 3, FLT:4GitHubcio ProjectFLT:5, או FLT:6 NotionFrated 7LT).

היתרונות של שימוש ב-Kanban for Documentation

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

שיפור השקיפות והשקיפות

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

חידושים משופרים ו-Alignment

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

בעלות ברורה וחשבונאות

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

מהירות יותר של מחזורי מזון וקיצור זמן לפרסום

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

עידוד שיפור מתמיד

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

לשבור את הסילוס ולקדם שיתוף ידע

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

יישום Kanban for Engineering Documentation: A Step-by-Step Guide

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

שלב 1: ממפה את זרימת העבודה הנוכחית שלך

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

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

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

שלב 2: יצירת מועצת הקנברן שלך

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

שלב 3: נענע את הוועדה עם משימות תיעוד

כל המסמכים הבולטים צריכים - הטלת הפניות של API, מדריכי התקנה מיושנים, החלטות אדריכליות לא מוקלטות. הוסף אלה ככרטיסים בעמודה "לעשות" לכל כרטיס, כוללים:

• (ב) ⁇ :0 (ב) ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇
• (ב) ,0) כתב: "התחילה" (בתרגום: ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇
• (ב) ⁇ (ב) ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇
• (ב) ויקרא י"א: "בְּבְהִיא עַל עַמֶּה" (בראשית כ"ד, כ"ד).
• (ב) ,0) תאריך: 1FLT 1 (אופציונלי) אך שימושי עבור תיעוד רגיש לזמן.
• [ה]מקרא: [ה] [ה] [ה] כ"הטוט" (הופנה מהדף "הציגו" את הסקירה הטכנית, "העשויה לשרשרת הראשית".

שלב 4: הגדר עבודה בגבולות התקדמות

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

שלב 5: החזיקו מעמד קבוע סביב מועצת המנהלים

התחל בכל יום (או כל פגישה) על ידי סקירת לוח קנבראן.

• מה עבר מאז אתמול?
• אילו קלפים חסומים ומדוע?
• אילו קלפים קרובים להזיז וזקוקים לעזרה?
• האם יש לכבד את גבולות ה-WIP? אם לא, איזו התאמה יש צורך?

הטקס הזה שומר על תיעוד גלוי ומעודד בעלות קולקטיבית.

שלב 6: שיפור מתמיד בתהליך

כל שבועיים, בצע רטרוספקטיבה על לוח התיעוד שלך Kanban. Measure metrics כגון:

• (ב) ויקרא י"א: "ה' י"א: "ה' י"א י"ב, ב'"ה', ב'"ה'" (בראשית כ"ד).
• (ב) מספר פריטים שפורסמו בשבוע (ב"ג)
• (ב) ,0) תדירות התדירות של בוטל-צוואר: 1FLT 1 אשר עמודה עולה באופן עקבי על גבול ה-WIP שלה.

הגדרות טור Tweak, גבולות WIP או מדיניות המבוססת על נתונים אלה. Kanban היא מערכת חיים.

היכרות עם ידע שיתוף פעולה

קנברן לא רק עוקב אחר משימות תיעוד - זה יכול גם להקל על שיתוף ידע רחב יותר.כאן כמה דרכים להרחיב את הערך שלו.

השתמש ב-שחייה עבור סוגי המסמכים

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

משימות של תיעוד Embeddation בפיתוח

כאשר תכונת חדשה מתוכננת, הוסף כרטיס תיעוד לדירקטוריון קנבר כצוללת של הכרטיס תכונה.זה מבטיח תיעוד כתוב לצד הקוד, לא נדחה.קבוצות רבות משתמשות ב-FLT:0GitHub IssuessFLT:1 או FLT:2arLineFLT 3 למטרה זו, קישור בין כרטיסי הנדסה להנדסת כרטיסים.

יצירת "ידע רואה"

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

שם מקור: Cross-Team Learning

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

השתמש בכרטיסי מחסנים כבסיס ידע חיפוש

כאשר כרטיס תיעוד מגיע לטור "Archive" (או לוח קשת נפרד), להבטיח את התוכן הסופי נשמר ב wiki, Confluence, Notion, או GitHub repository. לוח הקנברן עצמו הופך לתיעוד היסטורי של מי כתב את מה ומתי - יקר עבור על גבי לוחות חדשים.

כלים וידוי דוגמאות

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

אפשרות 1: GitHub Projects (חינם להנפקה ציבורית)

פרויקטים של GitHub מציעים לוח קאנבן מובנה מקושר לנושאים ובקשות למשוך.לתיעוד, ליצור פרויקט (board) עם עמודות: FLT:0.Backlog, לעשות, בקדמה, Review, DoneFLT:1 השתמש בתוויות כמו 'doc-API', 'Ddoc-onboarding', ו-'doc-doc-run'כל כרטיס הוא בעיה שיכולה להכיל סימני ציון דרך, או להזיזוכים, כלומר, אם הם סימנים מוקדמים, או רשימות.

אפשרות 2: טרלו (אפשרות עבור קבוצות קטנות)

טרילו הוא פשוט וויזואלי. ליצור לוח עם רשימות: FLT:0; Drafting, Tech Review, Editorial Review, Published, ArchivesFLT:1 השתמש בתוויות לעדיפות (אדום=אורגנטי, צהוב=medium, ירוק=נמוך) וסוג (API, RunBook, ADR, וכו ') פאוור-Ups כמו "אטלר" יכול להיות בעל רכב (למשל, כרטיס ביקור, לאחר בדיקה אוטומטית).

אפשרות 3: Jira (Enterprise with קיימות זרמי עבודה)

לוח הקנבאבן של ג'ירה יכול להיות מותאם עם זרמי עבודה מתקדמים. ליצור פרויקט עם סוג של "משימות ביצוע" (הגדרת לוח עם עמודות: FLT:0Backlog, In Development (Drafting), In Review, Approved, PublishedFPSK 1 ( השתמש בתכונות SLA של Jira כדי לעקוב אחר מחזור זמן.

הצלחה: מפתח מסובכים לתיעוד קבאן

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

זמן מחזור ופנים

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

גבולות ה-IP

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

ניתוח צוואר בקבוק

השתמש בתרשיםי זרימה מצטברים (זמין ב Jira ו- Azure DevOps) כדי לראות באיזה שלב יש את הצטברות הגבוהה ביותר של כרטיסי אשראי.העמודה היא צוואר הבקבוק שלך.לדוגמה, אם "לסקירה" יש כל הזמן 10 קלפים ואילו הגבלת WIP היא 5, אתה צריך יותר ביקורת או תהליך ביקורת מהיר יותר.

שביעות רצון של Team

האם אתה מבצע סקרים אנונימיים כדי לאמוד כיצד חברי הצוות מרגישים לגבי תהליך התיעוד: "אתה יודע איזו משימת תיעוד לעבוד על הבא?", "האם אתה מרגיש שתיעוד מוערך?", האם קל למצוא תיעוד קיים?"

ידע טריות

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

אתגרים משותפים וכיצד להתגבר עליהם

אימוץ קנברון לתיעוד אינו ללא מכשולים.כאן הם מכשולים ופתרונות טיפוסיים.

התנגדות לתיעוד

(ב) ,0) צ'אלנג: מהנדסים 1FLT רואים תיעוד חשוב פחות מקוד ומתנגדים להוספת כרטיסים לדירקטוריון.

(FLT:0) Solution: תיעוד מסגרת 1:1 כחלק קריטי של פיתוח - בלעדיו, על גבי לוחות איטיים ותקריות חוזרות.התחל עם תיעוד קטן, גבוה ערך (למשל, תרשים ארכיטקטורת מערכת, בדיקת שחרור).

יותר מדי קלפים, לא להתמקד

(ב) ⁇ :0) ,(פרק: 1) ה-FLT:1) הופך לקבר של משימות תיעוד בלתי צפויות, מביס את הצוות.

(FLT:0) solution: FLT:1 יישם גבולות WIP קפדניים באופן קבוע לטהר את הגיבוי.הזיז כרטיסי לא רציוננים ל"יום אחד / אולי" שין להתמקד ב-5% העליון של תיעוד המספק את הערך ביותר.

חוסר ביקורת

(ב) ⁇ :0) ,(פרק הסקירה (ב) , כרך 1:1, עמודת הביקורת ממלאת כי מעט מדי אנשים יש מומחיות בתחום כדי לבדוק.

(FLT:0) Solution: FLT:1 Broaden the reviewer Pool by Training יותר חברי צוות. השתמש ב"סקירה חולנית" שבו סקירה אחת בכירה ואחד זוטרת יחד - זה גם משמש להעברת ידע. הגדר ציפייה ברמת שירות (למשל, כל ביקורות הושלמו בתוך 48 שעות).

מועצת המנהלים Abandonment

(ב) ,0) צ'אלנג: 1 לאחר ההתלהבות הראשונית, הלוח מפסיק להיות מעודכן והופך לא רלוונטי.

(FLT:0) Solution: 1FLT) אינטגר את הלוח לתוך סטנד-אפים יומיים ותכנון קידוד. להפוך אותו למקור יחיד של אמת עבור משימות תיעוד. השתמש באוטומציה כדי להעביר כרטיסים כאשר יחסי ציבור ממוזגים או מבצעים הם דחפים.

מחקר מקרה: כיצד צוות הנדסה פלטפורמה השתמש קאנבן כדי להתפעל ויקי ויקי שלהם

נחשב דוגמה בדיונית אך ריאלית: צוות הנדסי פלטפורמה של 12 מהנדסים האחראים לכלי מפתח פנימיים. הוויקי שלהם היה מיושן עד 18 חודשים.על סיפון מהנדסים חדשים לקח שבועות כי תיעוד חסר או לא נכון, הם אימצו לוח קנבר עם עמודות: FLT:0Backlog, Drafting, Review, Published, PublishedFLT:1 והגדרת גבולות של 4 ב Drafting ו 6 שבועות ב- 4 חודשים לאחר מכן הם עברו 3 שבועות, 000 שעות עבודה.

מסקנה: התחל קטן, לשפר באופן רציף

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

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

(FLT:0) השלבים הבאים:IRFLT:1; Gather your team, ממפה את זרימת העבודה הנוכחית שלך, להגדיר לוח דין קאנבאן חודש אחד, ולהעריך את ההבדל.ההשקעה תשלם עבור עצמה פעמים רבות על פני חיכוך מופחת, מהר יותר על הסיפון, ופחות הפתעות.