פרויקט FOLIO
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בדף הזה מופיעים הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Docs ל-Google Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- FOLIO
- כותבים טכניים:
- gallinita
- שם הפרויקט:
- הרחבת מסמכי התיעוד למשתמשי קצה של אפליקציות FOLIO
- אורך הפרויקט:
- Long running (5 months)
תיאור הפרויקט
בפרויקט הזה, אני מתכנן ליצור ולעדכן את המסמכים של FOLIO שמיועדים למשתמש הקצה. FOLIO היא מערכת לניהול ספריות, ולכן משתמש הקצה הוא צוות הספרייה. נכון לעכשיו, הוויקי של FOLIO (https://wiki.folio.org/) מכיל מסמכי עזרה מסוימים, אבל הם מינימליים ולא בפורמט נוח לקריאה שנוצר תוך התחשבות בצוות הספרייה. המסמכים החדשים שייווצרו במסגרת הפרויקט הזה יתארחו בבסיס ידע ספציפי של מסמכי עזרה, שאפשר יהיה לגשת אליו מהאפליקציות של FOLIO. המסמכים האלה יכללו תהליכי עבודה שרלוונטיים למערכת ולמשתמשים בספרייה. קבוצה ראשונית של מסמכי עזרה תפורסם באתר, החל מהפונקציונליות של ספרייה וחדר לימודים. אני רוצה לתרום ככל האפשר למסמכי התיעוד במהלך הפרויקט הזה 'לטווח ארוך'.
במסגרת הבדיקה של פרויקט התיעוד של FOLIO, שוחחתי עם Marcia Borensztajn על הצרכים של FOLIO ועל המצב הנוכחי של התיעוד. כפי שצוין למעלה, יש צורך לעדכן, להרחיב ולעבד מחדש את המסמכים של FOLIO כדי לעזור למשתמשים. יש ליצור תיעוד כדי לשקף תהליכי ספרייה רגילים, ובגלל ש-FOLIO מורכב מ'אפליקציות' שונות שפועלות יחד, צריך להסביר את המערכת כולה. אני ספרן, ולכן אני מכיר היטב את סוגי התרחישים ותהליכי העבודה שסביר להניח שהמשתמשים של FOLIO יעברו בהם ויזדקקו לעזרה. מרסיה עובדת על יצירת מאגר הידע החדש של התיעוד באמצעות Markdown, Git והוגו. במסגרת הפרויקט הזה, המערכת תיצור תיעוד חדש ב-FOLIO ותשמש כמסגרת לעתיד.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[[["התוכן קל להבנה","easyToUnderstand","thumb-up"],["התוכן עזר לי לפתור בעיה","solvedMyProblem","thumb-up"],["סיבה אחרת","otherUp","thumb-up"]],[["חסרים לי מידע או פרטים","missingTheInformationINeed","thumb-down"],["התוכן מורכב מדי או עם יותר מדי שלבים","tooComplicatedTooManySteps","thumb-down"],["התוכן לא עדכני","outOfDate","thumb-down"],["בעיה בתרגום","translationIssue","thumb-down"],["בעיה בדוגמאות/בקוד","samplesCodeIssue","thumb-down"],["סיבה אחרת","otherDown","thumb-down"]],["עדכון אחרון: 2025-07-25 (שעון UTC)."],[[["This Google Season of Docs project focuses on expanding end-user documentation for the FOLIO library management system."],["The project aims to create digestible documentation for library staff, addressing current gaps in the FOLIO wiki."],["New documentation will be hosted on a dedicated knowledge base, accessible from FOLIO apps, and initially cover circulation and course reserves."],["The project will establish a framework for future FOLIO documentation development, drawing on the technical writer's library expertise and existing efforts by Marcia Borensztajn."]]],["The project focuses on creating and updating FOLIO documentation for library staff, the end users. The writer will develop documentation hosted on a new knowledge base accessible from FOLIO's apps. This documentation will detail workflows relevant to library staff, initially covering circulation and course reserves. The project aims to expand, update, and rework existing documentation to reflect standard library processes and explain how FOLIO's different apps function together as a system. The new documentation will be built using markdown, Git, and Hugo.\n"]]
