top of page

דוקומנטציה ומה נרשם

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


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


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

פוסטים אחרונים

הצג הכול

קוד לגאסי והעברה בין דורית

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

רקורסיה, תנאי עצירה וקול פנימי

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

דדלוק Deadlock

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

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

bottom of page