תיעוד
תיעוד הוא כל חומר שניתן להעברה המשמש לתיאור, הסבר או הדרכה לגבי תכונות מסוימות של אובייקט, מערכת או הליך, כגון חלקיו, הרכבתו, התקנתו, תחזוקתו והשימוש בו.[1] כצורה של ניהול ידע וארגון ידע (אנ'), תיעוד יכול להיות זמין על גבי נייר, באופן מקוון, או על מדיה דיגיטלית או מדיה אנלוגית (אנ'), כגון רשמקול או תקליטורים. דוגמאות לכך הן מדריכים למשתמש, ספרים לבנים, עזרה מקוונת (אנ') ומדריכי עזר מהירים. תיעוד על נייר או עותק קשיח הפך פחות נפוץ.[2] תיעוד מופץ לעיתים קרובות דרך אתרי אינטרנט, מוצרי תוכנה ויישומים מקוונים אחרים.
אין לטעות בין תיעוד כאוסף של חומרי הדרכה לבין מדע התיעוד (אנ'), חקר הרישום והאחזור של מידע.
עקרונות ליצירת תיעוד
אף על פי שהתקנים של ארגון התקינה הבין-לאומי (ISO) אינם זמינים לציבור בקלות, מדריך ממקורות אחרים בנושא זה יכול לשמש לאותה מטרה.[3][4][5][6]
פיתוח תיעוד עשוי לכלול ניסוח מסמכים, עיצובם, הגשתם, סקירתם, אישורם, הפצתם, פרסומם מחדש ומעקב אחריהם, וכל אלה נעשים בהתאם לנוהל תפעול סטנדרטי (אנ') הנהוג בתעשייה הכפופה לרגולציה. התהליך יכול לכלול גם יצירת תוכן מאפס. תיעוד צריך להיות קל לקריאה ולהבנה. אם הוא ארוך מדי ורב-מלל, הוא עלול להיות מובן שלא כהלכה או שיתעלמו ממנו. יש להשתמש במילים ברורות ותמציתיות, ויש להגביל את אורך המשפטים ל-15 מילים לכל היותר. בתיעוד המיועד לקהל הרחב יש להימנע משימוש במונחים מגדריים ומהטיות תרבותיות. בסדרת נהלים, יש למספר את השלבים באופן ברור.[7][8] חלק ממאפייני האיכות של תיעוד הם: שלמות, בהירות, הבנה, מבנה, נכונות, עריכה, מעקביות, שלמות/אותנטיות (למשל, היסטוריית שינויים), אובייקטיביות.
הפקת תיעוד
כותבים טכניים ואנשי התקשורת של התאגיד/חברה הם אנשי מקצוע שתחום עיסוקם ועבודתם הוא תיעוד. באופן אידיאלי, לכותבים טכניים יש רקע הן בנושא המתועד והן בכתיבה, ניהול תוכן וארכיטקטורת מידע. כותבים טכניים משתפים פעולה בדרך כלל עם מומחי תוכן (אנ'), כגון מהנדסים, מומחים טכניים, אנשי מקצוע רפואיים וכו', כדי להגדיר ולאחר מכן ליצור תיעוד שיענה על צורכי המשתמש. תקשורת תאגידית (אנ') כוללת סוגים אחרים של תיעוד כתוב, לדוגמה:
- תקשורת שיווקית (MarCom): כותבי MarCom שואפים להעביר את הצעת הערך של החברה באמצעות מגוון אמצעי דפוס, מדיה אלקטרונית ומדיה חברתית. תחום זה של כתיבה תאגידית עוסק לעיתים קרובות במענה להצעות.
- תקשורת טכנית (TechCom): כותבים טכניים מתעדים את המוצר או השירות של החברה. פרסומים טכניים יכולים לכלול מדריכים למשתמש, מדריכי התקנה ותצורה, ונהלים לאיתור תקלות ותיקונן.
- שפה משפטית: סוג זה של תיעוד מוכן לעיתים קרובות על ידי עורכי דין או עוזרים משפטיים.
- תיעוד ציות: סוג זה של תיעוד מקדד נהלי עבודה סטנדרטיים, עבור כל צורך של ציות רגולטורי, כמו אישורי בטיחות, מיסוי, מימון ואישורים טכניים.
- תיעוד בתחום הבריאות: תחום תיעוד זה כולל רישום ואימות בזמן אמת של אירועים שהתרחשו במהלך מתן טיפול רפואי.[9]
תיעוד במדעי המחשב
סוגים
להלן סוגים נפוצים של תיעוד תוכנה:
- בקשה להצעות (אנ')
- דרישות / מפרט (הנדסה) (אנ') / היקף העבודה
- עיצוב תוכנה ומפרט פונקציונלי (אנ')
- עיצוב מערכת (אנ') ומפרטים פונקציונליים
- ניהול שינויים, מעקב אחר שגיאות ושיפורים
- בדיקות קבלה של משתמשים
להלן סוגים נפוצים של תיעוד חומרה ושירותים:
- דיאגרמות רשת (אנ')
- מפות רשת (אנ')
- גיליון נתונים למערכות טכנולוגיית המידע (למשל, שרתים, מתגים)
- קטלוג שירותים (אנ') וספריית התשתיות של מערכות המידע
קישורים חיצוניים
- תיעוד, באתר אנציקלופדיה בריטניקה (באנגלית)
- IEEE Professional Communication Society
- Information & Documentation List of selected tools
הערות שוליים
- ↑ "Documentation definition by The Linux Information Project". www.linfo.org.
- ↑ The decline of paper: a passing trend or the future of printing?
- ↑ "Guide to Documentation" (PDF). somers.k12.ct.us. 2003. אורכב מ-המקור (PDF) ב-29 ביולי 2007.
{{cite web}}: (עזרה) - ↑ CGRP. "A Guide to Documentation Styles" (PDF). San Francisco State University. אורכב מ-המקור (PDF) ב-5 ינו' 2011.
{{cite web}}: (עזרה) - ↑ "A guide to MLA documentation" (PDF). sunyjcc. אורכב מ-המקור (PDF) ב-2 בספטמבר 2006.
{{cite web}}: (עזרה) - ↑ Berger, David. "Procedures and Documentation" (PDF). maintenanceonline. אורכב מ-המקור (PDF) ב-27 ביולי 2011.
{{cite web}}: (עזרה) - ↑ Cropper, Mark; Dibbens, Tony (2002). "GAIA-RVS Documentation Procedures" (PDF). mssl.ucl.ac.uk. אורכב מ-המקור (PDF) ב-2 בנובמבר 2005.
{{cite web}}: (עזרה) - ↑ UK Data Archive (2009). "Data Services Process Guides: Documentation Processing Procedures" (PDF). esds.ac.uk. אורכב מ-המקור (PDF) ב-13 ביוני 2010.
{{cite web}}: (עזרה) - ↑ Springhouse (2008). Complete Guide to Documentation. Lippincott Williams & Wilkins. p. ix. ISBN 9781582555560.
תיעוד41888580Q788790