שלום לכולם!
שמי מאשה, אני עובד כמהנדס אבטחת איכות בקבוצת החברות של טינקוף. עבודת QA כוללת הרבה תקשורת עם אנשים שונים מצוותים שונים, והייתי גם מנהלת ומרצה של תכניות חינוכיות, כך שמפת התקשורת שלי הייתה רחבה ככל האפשר. ובשלב מסוים התפוצצתי: הבנתי שאני לא יכול, אני לא יכול, אני לא יכול למלא טונות גיהנומיות של טבלאות ומסמכים בלתי קריאים.
בטח כל אחד מכם דמיין עכשיו על מה אני מדבר ופרץ בזיעה קרה: רשימות של שמות משפחה ללא סדר אלפביתי, טבלאות עם מאות עמודות עם פריסה עקומה, טבלאות עם אלפי שורות שבהן צריך לנגב את האצבע. על גלגל העכבר כדי להסתכל על הכותרת, טונות של דפים של הוראות לא ממוספרות, מאות מכתבים שנשלחו זה לזה עם נתונים שצריך לנתח ולעשות שיטתיות ולהכניס לטבלאות בלתי קריאות באותה מידה.
וכך, כשהתקררתי מעט, החלטתי לכתוב את המאמר הזה. אני אדבר על איך אתה יכול בדרך כלל (אפילו לפעמים בנוחות) לשמור על מגוון תיעוד שאינו מוצר. אני מקווה שהכתבה תתפשט ברחבי האינטרנט ורמת הגיהנום במחלקות הסמוכות לפיתוח תקטן לפחות במעט, ואנשים (כולל אני) יהיו קצת יותר מאושרים.
כלי עבודה
תיעוד המוצר נשמר לעתים קרובות ליד הקוד, וזה דבר טוב. ותיעוד שאינו מוצר מאוחסן בדרך כלל בכל מקום. אנשים מנסים לעתים קרובות להעביר מידע ממקומות שונים לתוך מפגש, ואנחנו לא יוצאי דופן. אז שאר הסיפור הוא עליו.
באופן כללי, Confluence הוא מנוע ויקי מתקדם. זה מאפשר לך לעבוד עם נתונים בסוגים שונים של תצוגה: טקסט עם עיצוב, טבלאות, תרשימים שונים. זהו כלי מאוד מעניין ועוצמתי, אבל אם אינך יודע כיצד להכין אותו, בסופו של דבר תהיה לך עוד מזבלה של מסמכים בלתי קריאים. אני אלמד אותך איך לבשל!
מאקרו
כמעט כל הקסם של Confluence מגיע מפקודות מאקרו. יש הרבה פקודות מאקרו, וניתן לשלב אותן אחת עם השנייה. הם יכולים להיות בתשלום או בחינם; למטה יהיו דוגמאות שונות של פקודות מאקרו עם קישורים לתיעוד עבורם.
הממשק לעבודה עם פקודות מאקרו פשוט ככל האפשר. כדי להוסיף מאקרו, עליך ללחוץ על הפלוס ולבחור את האלמנט הרצוי מהרשימה.
אם מאקרו הוא עצמאי, כלומר, הוא אינו מצריך הכנסת שום דבר אחר בתוך עצמו, הוא נראה כמו בלוק.
אם מאקרו דורש לשים משהו בתוכו כדי שהוא יעבוד, הוא נראה כמו מסגרת.
יחד עם זאת, אתה יכול למקם כמה אחרים שאתה רוצה בתוך פריים אחד, כל עוד יש היגיון בפירמידה שלך.
לכל מאקרו יש תצוגה מקדימה: הוא מראה מיד אם מילאתם והגדרתם את המאקרו בצורה נכונה.
תבניות
בנוסף לפקודות מאקרו, יש כלי נוח למילוי תוכן מראש - תבנית.
ניתן להשתמש בתבניות בעת יצירת כל עמוד: פשוט לחץ על שלוש הנקודות שליד כפתור "צור" ובחר את התבנית הרצויה.
לאחר מכן כל התוכן שנמצא בתבנית יתווסף לעמוד שנוצר.
כל אחד יכול ליצור דפים מתבניות, אבל רק מי שיש לו את הזכויות ליצור או לערוך את התבניות בעצמו יכול לעשות זאת. ניתן להוסיף הוראות נוספות לתבנית לגבי אופן תחזוקת הדף.
הקסם של שולחנות
למעשה, בתור טכנאי, אני מאוד אוהב טבלאות ויכול לעטוף בהם כמעט כל מידע (למרות שזה לא תמיד יעיל). השולחנות עצמם ברורים, מובנים, ניתנים להרחבה, קסומים!
אבל אפילו ישות נפלאה כמו שולחן יכולה להיהרס. ואתה יכול להשתמש בו בהצלחה ואף לשפר אותו. עוד על כך בהמשך.
סינון (תוסף בתשלום)
כל טבלה ענקית ולא ניתנת לקריאה יכולה להיעשות קצת פחות ענקית וקצת יותר קריאה באמצעות סינון. אתה יכול להשתמש במאקרו בתשלום בשביל זה .
אתה צריך לשים טבלה בתוך המאקרו הזה (גם המכוער ביותר אפשרי, העיקר לדחוף אותה בשלמותה). במאקרו, תוכל לבחור עמודות עבור המסנן הנפתח, מסנן הטקסט, המסנן המספרי ומסנן התאריכים.
רק דמיינו שכל המידע על המועמדים לכל המשרות הפנויות נרשם ברשימה טבלה. מטבע הדברים, לא ממוינים - אנשים מגיעים לראיונות שלא לפי סדר אלפביתי. ואתה צריך להבין אם ראיינת מועמד ספציפי בעבר. אתה רק צריך להכניס את הגיהנום הזה למאקרו פילטר, להוסיף מסנן טקסט לפי שם משפחה - והרי, המידע נמצא על המסך שלך.
ראוי לציין שסינון טבלאות ענק יכול להשפיע על ביצועי המערכת וזמני טעינת הדפים, ולכן הכנסת טבלה ענקית למסנן היא קב זמני; עדיף לבנות תהליך שבו אנשים לא צריכים ליצור טבלאות ענקיות ובלתי ניתנות לקריאה ( דוגמה לתהליך תהיה בסוף המאמר).
מיון (תוסף בתשלום)
שימוש במאקרו קסם אתה יכול גם להגדיר את המיון המוגדר כברירת מחדל בכל עמודה ולמספר את השורות. לחלופין, לחץ על עמודה כלשהי בטבלה שהוכנסה למאקרו המסנן, והמיון יתרחש לפי העמודה הזו.
למשל, יש לכם את אותה טבלה עם מועמדים ואתם צריכים להעריך כמה ראיונות נערכו בחודש מסוים - מיין לפי תאריך ותשמח.
טבלאות ציר (תוסף בתשלום)
כעת נעבור למקרה מעניין יותר. תארו לעצמכם שהשולחן שלכם ענק ואתם צריכים לחשב ממנו משהו. כמובן, אתה יכול להעתיק אותו לאקסל, לחשב את מה שאתה צריך ולהעלות את הנתונים בחזרה ל-Confluence. האם אתה יכול להשתמש במאקרו פעם אחת? ולקבל את אותה תוצאה, רק מעודכנת.
לדוגמא: יש לכם טבלה שאוספת נתונים מכל העובדים – היכן הם ממוקמים גיאוגרפית ובאילו תפקידים הם תופסים. כדי לחשב כמה אנשים יש בכל עיר, עליך לבחור את השורה במאקרו PivotTable שצוברת את הנתונים (מיקום) וסוג הפעולה (תוספת).
באופן טבעי, ניתן לקבץ לפי מספר קריטריונים בו זמנית, ניתן לראות את כל האפשרויות .
תרשימים (פלאגין בתשלום)
כמו שאמרתי, לא כולם אוהבים שולחנות כמוני. למרבה הצער, רוב המנהלים לא אוהבים אותם בכלל. אבל כולם באמת אוהבים דיאגרמות בצבעים בהירים.
היוצרים של Confluence בהחלט ידעו על זה (כנראה יש להם גם בוסים שאוהבים דוחות ודיאגרמות, איפה הם היו בלי זה). לכן, אתה יכול להשתמש במאקרו הקסם . במאקרו הזה אתה צריך לשים את טבלת הציר מהפסקה הקודמת, והרי - הנתונים המשעממים האפורים שלך מוצגים יפה.
כמובן שגם למאקרו הזה יש הגדרות. ניתן למצוא קישור לתיעוד עבור כל מאקרו במצב העריכה של אותו מאקרו.
צבירה קלה
המידע מהפסקאות הקודמות כנראה לא היה גילוי בשבילך. אבל עכשיו אתה בהחלט יודע איך להשתמש בפקודות מאקרו, ואני יכול לעבור לחלק המעניין יותר של המאמר.
תגיות
זה רע כשאנשים מאחסנים מידע במאמר אחד לא מובנה או בטבלה ענקית. זה אפילו יותר גרוע כאשר חלקים מהמידע הזה לא רק מעוצבים בצורה בלתי קריא, אלא גם מפוזרים ברחבי Confluence. למרבה המזל, ניתן לאסוף מידע מפוזר במקום אחד. כדי לעשות זאת אתה צריך להשתמש (תיוגים המוכרים לכולם מהרשתות החברתיות).
אתה יכול להוסיף כל מספר של תגים לכל עמוד. לחיצה על תג תעביר אותך לדף צבירה עם קישורים לכל התוכן עם אותו תג, כמו גם קבוצה של תגים קשורים. תגים קשורים הם אלו המופיעים לעתים קרובות באותו עמוד.
מאפייני עמוד
אתה יכול להוסיף מאקרו מעניין נוסף לדף כדי לבנות מידע - . בתוכו אתה צריך להגיש טבלה של שתי עמודות, הראשונה תהיה המפתח, והשנייה תהיה ערך הנכס. יתרה מכך, ניתן להסתיר את המאקרו מהעמוד כדי שלא יפריע לקריאת התוכן, אך העמוד עדיין יסומן במקשים הדרושים.
שימו לב לזיהוי - נוח להגדיר אותו כך שיקצה קבוצות שונות של נכסים לדפים שונים (או אפילו קבוצות שונות של נכסים לעמוד אחד).
דוחות
אתה יכול לאסוף דוחות באמצעות תגים. לדוגמה, מאקרו אוסף את כל הדפים עם קבוצה מסוימת של תגים.
אבל דוח מעניין יותר הוא המאקרו . הוא גם אוסף את כל הדפים עם קבוצה מסוימת של תגים, אבל הוא לא מציג רק רשימה שלהם, אלא יוצר טבלה (אתה קולט את הקשר עם תחילת המאמר?), שבה העמודות הן העמוד מפתחות נכס.
התוצאה היא טבלת סיכום של מידע ממקורות שונים. זה נחמד שיש לו פונקציות נוחות: פריסה אדפטיבית, מיון לפי כל עמודה. כמו כן, ניתן להגדיר טבלת דיווח כזו בתוך מאקרו.
בעת הגדרת התצורה, תוכל להסיר כמה עמודות מהדוח, להגדיר מצב ברירת מחדל או את מספר הרשומות המוצגות. אתה יכול גם להגדיר את מזהה נכס הדף כך שיראה רק את המידע שאתה צריך.
למשל, יש לך הרבה דפי עובדים, לדפים האלה יש סט של מאפיינים על האדם: באיזו רמה הוא נמצא, איפה הוא נמצא, מתי הצטרף לצוות וכדומה. מאפיינים אלה מסומנים ID = עובד_מידע. ויש קבוצה שנייה של מאפיינים באותו עמוד, שמכילה מידע על האדם כחלק מהצוות: איזה תפקיד ממלא האדם, באיזה צוות הוא נמצא וכו'. מאפיינים אלה מסומנים ID = team_inf. לאחר מכן, בעת עריכת דוח, ניתן להציג רק מידע עבור מזהה אחד או שניים בבת אחת - מה שנוח מביניהם.
היופי בגישה הזו הוא שכל אחד יכול להרכיב את טבלת המידע שהוא צריך, שלא ישכפל דבר ותעודכן עם עדכון העמוד הראשי. לדוגמא: לא משנה לראש צוות מתי המפתחים שלו קיבלו עבודה, אבל חשוב איזה תפקיד כל אחד מהם ממלא בצוות. ראש הצוות יאסוף דוח על הצוות. ולרואה החשבון בכלל לא אכפת מי ממלא איזה תפקיד, אבל התפקידים חשובים - הוא יערוך דוח על התפקידים. במקרה זה, מקור המידע לא ישוכפל או יועבר.
תהליך סופי
הוראה
אז, אנחנו יכולים לבנות בצורה יפה ולצבור מידע ביעילות ב-Confluence באמצעות פקודות מאקרו כדוגמה. אבל באופן אידיאלי, אתה צריך לוודא שמידע חדש מובנה באופן מיידי ונכנס לכל מנגנוני הצבירה שכבר נמצאים בשימוש.
זה המקום שבו חבורה של פקודות מאקרו ותבניות יבואו להציל. כדי לאלץ אנשים ליצור דפים חדשים בפורמט הרצוי, אתה יכול להשתמש במאקרו צור מתבנית. זה מוסיף כפתור לדף, כאשר לוחצים עליו, נוצר דף חדש מהתבנית שאתה צריך. כך אתה מכריח אנשים לעבוד מיד בפורמט שאתה צריך.
בתבנית שממנה אתה יוצר עמוד, אתה צריך להוסיף תוויות, מאקרו "מאפייני עמוד" וטבלה של המאפיינים שאתה צריך מראש. אני גם ממליץ להוסיף הוראות לגבי הערכים שיש למלא בדף, וערכי הנכס.
ואז התהליך הסופי ייראה כך:
- אתה יוצר תבנית עבור סוג מסוים של מידע.
- בתבנית זו אתה מוסיף תוויות ומאפייני עמוד במאקרו.
- בכל מקום נוח, צור עמוד שורש עם כפתור, לחיצה עליו יוצרת עמוד צאצא מהתבנית.
- אתה נותן למשתמשים לעבור לדף השורש, שיוכל ליצור את המידע הדרוש (לפי התבנית הנדרשת, על ידי לחיצה על כפתור).
- אתה אוסף דוח על מאפייני הדף באמצעות התגים שציינת בתבנית.
- תשמחו: יש לכם את כל המידע הדרוש בפורמט נוח.
חסרונות
כמהנדס איכותי, אני יכול לומר בבטחה ששום דבר אינו מושלם בעולם. אפילו שולחנות אלוהיים אינם מושלמים. ויש מלכודות בתהליך הנ"ל.
- אם תחליט לשנות את השמות או ההרכב של מאפייני העמוד, תצטרך לעדכן את כל האובייקטים שכבר נוצרו כך שהנתונים שלהם ייכללו בצורה נכונה בדוח הסיכום. זה עצוב, אבל מצד שני, זה מאלץ אותך לחשוב בפירוט על ה"ארכיטקטורה" של מערך המידע שלך, וזו משימה מאוד מעניינת.
- תצטרך לכתוב כמות נכבדת של הוראות כיצד למלא טבלאות מידע ולהשתמש בתגיות. אבל מצד שני, אתה יכול פשוט לפגוע בכל האנשים הנכונים עם המאמר הזה.
דוגמה לאחסון תיעוד שאינו מוצר
באמצעות התהליך המתואר לעיל, אתה יכול לארגן את האחסון של כמעט כל מידע. היופי בגישה הוא שהיא אוניברסלית: ברגע שהמשתמשים מתרגלים אליה, הם מפסיקים ליצור בלגן. יתרון גדול נוסף (אך לא חינמי) הוא היכולת לאסוף נתונים סטטיסטיים שונים תוך כדי תנועה ולצייר דיאגרמות יפות על בסיסן.
הרשה לי לתת לך דוגמה לתהליך שלנו לשמירה על מידע על צוות.
החלטנו ליצור כרטיס עובד לכל אחד בצוות. בהתאם לכך, יש לנו תבנית לפיה כל אדם חדש יוצר לעצמו את הכרטיס הזה ושומר בו את כל המידע האישי.
כפי שאתה יכול לראות, יש לנו טבלה מפורטת של נכסים ומיד יש לנו הוראות איך בדיוק לתחזק את הדף הזה. חלק מהתגים מתווספים על ידי העובדים עצמם לפי הנחיות, התבנית מכילה רק את העיקריות שבהן: תג כרטיס כרטיס עובד, תג כיוון כיוון-כרוך ותג צוות צוות-qa.
כתוצאה מכך, לאחר שכל אחד יצר לעצמו כרטיס, מתקבלת טבלה מלאה עם מידע על העובדים. ניתן להשתמש במידע זה בנקודות שונות. מנהלי משאבים יכולים לאסוף לעצמם טבלאות כלליות, ומובילי צוות יכולים ליצור טבלאות צוות על ידי הוספת תג צוות לבחירה.
אתה יכול לראות סיכומים שונים לפי תגים, למשל qa-upgrade-plan כל משימות פיתוח ה-QA יוצגו. במקביל, כל אדם שומר היסטוריה חשובה ותוכנית פיתוח משלו בכרטיס העובד שלו - יוצר עמוד מקונן מתבנית תוכניות הפיתוח.
מסקנה
שמרו על כל תיעוד בצורה כזו שלא תהיה בו בושה, וזה לא גורם לכאבי תופת למשתמשים!
אני מאוד מקווה שהמאמר יועיל ויגיע סדר בכל התיעוד שבעולם.
מקור: www.habr.com
