הפרקטיקה הטובה ביותר לתיעוד פרטים על תחזוקה לטווח ארוך

תפקיד רישום בתחזוקה ארוכת טווח

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

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

יתר על כן, כמו הרשמה מעבר יותר ויותר מגורמים פיזיים למסד נתונים דיגיטלי, הצורך בתיעוד חזק יותר. רישומים דיגיטליים מסתמכים על תלות בתוכנה מורכבת, מטבולונים schemas ו אחסון הגירסה, אשר יש להסביר בבירור עבור מטפלים עתידיים. a היטב documented רישום ניתן להגר, לחקות, או re-Relemented עם אובדן מינימלי של delity זה, לעזור לך לעמוד במרכיבים קריטיים, כדי לעמוד על ידי שימוש יעיל.

המונחים: Thorough Register Documentation

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

מקור: Proance and Source Attribution

לכל רישום יש היסטוריה. מסמך שבו נרשם הרישום, אשר יצר אותו, ובסמכותו של ה- 1800, כולל את שמו של היוצר או המוסד, תאריך הבריאה, וכל העברה מאוחרת של משמורת.לדוגמה, רישום קהילה מ 1800 יכול היה להיות מיקרו-סרטונים בשנת 1970 וספרות ב-2010; כל צעד צריך להיות נרשם.

מפרט עיצוב ותבניות פורמט

תאר את המבנה הפיזי או הדיגיטלי של הרישום, עבור רישום נייר, לציין את מספר העמודים, ראשי העמודים, פריסת העמוד, וכל מחייב מיוחד. עבור רישום דיגיטלי, ציין את תבנית הקובץ (למשל, CSV, XML, XML, JSON), ⁇ (UTF-8, ASCII), דמויות דלימיטר, סוגי נתונים, ואורך שדה לרשום את מסד הנתונים, אם משתמשים במערכת ניהול מסד נתונים, תיעוד, טבלאות מדויקות, במיוחד, כדי לאפשר טבלאות חדשות, לוחות זמנים מדויקים, במיוחד, לוחות זמנים מדויקים, ותיעוד, במיוחד, ותיעוד.

קיצורים, קודים, ולשלוט ב Vocabularies

לעתים קרובות משתמשים בקודים קצרים, מספריים, או מונחים מבוקרים כדי לחסוך מקום ולשמור על עקביות. Document Every abbreviation or Code המשמש, יחד עם המשמעות המלאה שלה וכל כללי השימוש.לדוגמה, ברישום מפקד האוכלוסין, "M" עשוי לעמוד על "Male" או "מבוגר", בהתאם לטור אוצר המילים הנשלט על ידי הכיבוש, שמות, או צריך להיות רשום עם מקורות ורישום חיצוני (להלן: 1.10.

בקרת גישה וניהול

לא כל הרשומות פתוחות בפני כולם. Document אשר עשוי להציג, לערוך או למחוק רשומות, ובכפוף לתנאים. Include כל הגבלות פרטיות (למשל, HIPAA עבור רשומות רפואיות, GDPR עבור נתונים אישיים), תקופות אמברגו, או גישה ל- tiers. גם לציין אמצעי אבטחה פיזיים עבור רישום נייר (למשל, חסיני אש, אחסון אקלים) ואמצעי אבטחה דיגיטליים (למשל, הגנה מפני יישומים, גיבויים, אימותים).

שינוי ההיסטוריה וגרסה מעקב

רישום הוא לעתים נדירות סטטי.כל תיקון, עדכון או תוספת צריך להיות במעקב באמצעות מערכת בקרת שינוי או גירסה. Document the date, Nature of the Change, אשר ביצע אותו, והסיבה לכך. עבור רישומים דיגיטליים, כלים כמו Git יכולים לשמור על היסטוריה מלאה של מבצעים. for Paper Registers, הערות שוליים או ספר קידוד מתואם מספיק.

הפרקטיקה הטובה ביותר לתיעוד יעיל

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

אימוץ מטבוליזם סטנדרטי של Metadata Schemas

במקום להמציא את מבנה התיעוד שלך, מינוף תקנים metadata מבוססים על תקנים (FLT:0) ,Lowlin CoreFLT:1 מספק אוצר מילים פשוט עבור metadata תיאורי, בעוד FLT:2Encoded Archival Description (EAD)Buildal Description) 3 מותאם ל-Arcial Finds.

שמירה על Active Control

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

יצירת מסמך אנושי-קראי ומכונה-Readable Documentation

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

רכבת כל אדם

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

ביקורת וביקורת על מסמך מעת לעת

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

תוכנית הגירה ומיילדות

המסמכים צריכים לצפות כי פורמט הרישום הנוכחי יהיה בסופו של דבר מיושן.כולל הוראות להעברת נתונים לפורמט עתידי, כולל טבלאות מיפוי בין שדות ישנים וחדשים. עבור רישומים דיגיטליים, לציין את התלויים בתוכנה (למשל, גרסת מסד נתונים, מערכת הפעלה, ספריות) וכל quirks ידועים. for Papers, אמצעי שימור וניהול.For-For-view תיעוד הוא הנכס הגדול ביותר כאשר יש לרשום טכנולוגיה אחת לדור הבא.

תקני מסמכים ומסגרות

[ה]כמה מסגרות מבוססות מספקות בסיס מוצק לתיעוד הרישום (הועד הבינלאומי לארכיונים (ICA) פרסם את ה-FLT:0ISAD(G)IRFLT:1 (התיאור הכללי של ארצ'יל), הקובע אלמנטים כגון זהות, הקשר ותכנים.The FLT:2Dublin Core Metadata InitiativeF3LT מציע 15 אלמנטים מרכזיים לשימוש נרחב עבור גילוי משאבים ו-ACDFmains (המשך)

בחירת תקן הנכון תלויה בתחום הרישום שלך ואת הקהל המיועד.במקרים רבים, אתה יכול לשלב סטנדרטים מרובים: להשתמש דבלין הליבה עבור תיאור ברמה גבוהה, EAD עבור היררכיה מבנית, ו METS עבור אריזה.המפתח הוא לאמץ תקן ולא להמציא את הגלגל מחדש, וכדי לתעד את הבחירה שלך כך מתורגמנים עתידיים יודעים אילו כללים עוקבים אחר כך עבור הדרכה נוספת, להתייעץ עם ה-FLT: תקנים של מרכז תפוצה: 1.

כלים וטכנולוגיות לתיעוד

מסמכי תיעוד

(הופנה מהדףים) נהנים מכלים שיוצרים באופן אוטומטי תיעוד של סכימה. PostgreSQL מציע פונקציות מבוססות-in-in-Comments המוסיפים תיאורים לטבלאות ולעמודות. Tools כגון FLT:0SchemaSpyFLT:1 יכול לייצר תיעוד HTML אינטראקטיבי המציג מערכות יחסים ועמודות.

פלטפורמות מסמכים שיתופיות

(ב) , (ב) , ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇

מגזינים ו- Registries

(העורךים המיוחדים של מט-נתונים, כגון FLT:0Archivist's ToolkitFLT:1 או FLT:2 OpenMetadataFLT 3, מספקים צורות מובנה להזנת נתונים, מנהליים וטכניים, כלים אלה לעתים קרובות מייצאים XML תואם ל- EAD, METS, או דבלין CoreLT עבור תיעוד נרחב, לשקול שימוש בהגדרה של קודים, 11Fvable, קובצי PDF, ו-F.

מערכות בקרת גרסאות

Git הוא תקן דה Facto עבור גרסאות תיעוד קבצים. Host repositories על פלטפורמות כמו GitHub, GitLab, או מקרים מעוותים עצמי. השתמש אסטרטגיות סניף כדי להפריד תיעוד יציב מהעבודה התקדמות. . Tag עם מספרי גרסאות המתאימות לרשום עדכונים. עבור רישום נייר, לשקול ספר פשוט עם תאריך, שינוי תיאור, וראשית - אבל להזין אלה לחיפוש קל יותר וגיבוי.

מערכות שימור דיגיטליות

(ב) , (ב) , ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇ ⁇

מלכודות נפוצות וכיצד להימנע מהם

⁇ in Abbreviations

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

Over-reliance on Institutional Memory

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

קריטריונים לא עקביים לאורך מסמכים

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

התעלמות מעיצוב של תיעוד עצמי

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

מחקרים: תיעוד בפעולה

19-Century Parish Registers בבריטניה

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

מערכת רישום סטודנטים של אוניברסיטת

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

קידום עתידי של מסמך הרישום שלך

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

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

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

מסקנה

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