פרויקט FreeBSD
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- פרויקט FreeBSD
- כותבים טכניים:
- The King of Toasters
- שם הפרויקט:
- כתיבת דפי אדם חסרים, הוספת EXAMPLE קטעים לדפי אדם
- אורך הפרויקט:
- אורך סטנדרטי (3 חודשים)
תיאור הפרויקט
כתיבה של מדריכי man חסרים:
רשימה של מדריכי man חסרים זמינה בכתובת https://wiki.freebsd.org/MissingManpages. מתחילים לכתוב כמה שיותר דפי הוראות מהרשימה הזו. בעזרת המנטור, תוכלו למצוא את המחבר או מישהו ששינה לאחרונה את קובץ המקור שאליו מתייחסת דף ה-man הרלוונטי, כדי לקבל מידע רקע ופרטים.
הוספת קטעים לדוגמה לדפי עזרה:
במקומות רבים במסמכי man של FreeBSD יש קטעים של דוגמאות, שמתארים את השימוש הבסיסי בכלי או בפקודה המתוארים בהם. בוויקי של FreeBSD יש רשימה של דפי עזרה ללא דוגמאות (https://wiki.freebsd.org/ManPagesWithoutExamples). מומלץ להוסיף כמה שיותר דוגמאות למסמכי man במקרים שבהם זה הגיוני. כדאי לחשוב על דרך כללית להציג את הפקודה או השירות בכלי האלה (למשל, מדריך למתחילים קודם, ואז דוגמאות מתקדמות יותר) ולהחיל את השיטה הזו על דפי ידניים שמתארים שירותים או פקודות דומים. כך, הדוגמאות יהיו עקביות והקורא יוכל למצוא את הדברים בקלות.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון 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)."],[],["The FreeBSD Project, in collaboration with technical writer \"The King of Toasters,\" will undertake a technical writing project focused on man pages. The project includes creating missing man pages from a specified list, using source file authors for guidance. Additionally, the project will add EXAMPLE sections to existing man pages that lack them, following a consistent structure of introductory and then advanced examples to improve readability and usability. The project duration will be three months.\n"]]
