תוֹכֶן

• צעדים
• טיפים
• מה אתה צריך

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

צעדים

1. 1 כלול פרטי יצירת קשר. זהו כנראה החלק החשוב ביותר במסמך הקדם -רישום. פרטי יצירת הקשר יאפשרו למשתמש ליצור איתך קשר על מנת להציע לך להשלים את התוכנית, לשאול שאלה, לתקן שגיאה או לשלם עבור התוכנית. כלול את שם החברה, אתר האינטרנט, הדוא"ל ומספר הטלפון (מידע זה ייקח כמה שורות).
   • מוצגת דוגמה בתמונה.
2. 2 הכנס את התאריך למערכת הקריאה שלך. זהו צעד קטן אך חשוב מאוד. חשוב לציין את תאריך ההפצה של התוכנית שלך. בדרך זו, המשתמשים יהיו מודעים לעדכוני גרסת התוכנית ויוכלו גם לקבוע אם הוא עדיין נתמך.
3. 3 רשום את שם התוכנית, הגירסה ומידע התמחור. למעלה, כתוב את שם היישום ומספר הגירסה. אנא כתוב את המחיר לגרסה המלאה למטה. אם אתה מפיץ את התוכנית באמצעות מדיה פיזית כגון תקליטור, אינך יכול לכלול את פרטי התמחור מכיוון שמשתמשים כנראה כבר שילמו עבור התוכנית.
4. 4 תאר בקצרה את התוכנית. תן תיאור קצר של התוכנית שלך במשפט או שניים. לדוגמה: "יישום זה עוקב אחר מצב הרוח של המשתמש על ידי ניתוח הפעילות שלו באינטרנט, ולאחר מכן משנה את המרחב בשולחן העבודה באופן שיתאים את עצמו למצבו הרגשי של המשתמש."
   • אם התוכנה שלך כוללת מגוון רחב למדי של תכונות, תוכל להאריך את התיאור בפסקה או שתיים שלמות. אתה יכול להשתמש ברשימת תבליטים כדי למספר את כל הפונקציות והתכונות של התוכנית.
5. 5 תאר את דרישות המינימום לתוכנית. קובץ Readme טוב צריך להכיל מידע לגבי דרישות המינימום לתוכנית והוראות להתקנה. אם אתה זקוק לתוכנה נוספת להתקנת התוכנית, הקפד לציין זאת. תוכל גם לכלול מידע על דרישות מומלצות (למשל, עומס מעבד).
6. 6 כלול מידע על רישיון וזכויות יוצרים. בסופו של דבר, אל תשכח לכלול מידע אודות מועד הקמת זכויות היוצרים ורישוי התוכנית.

טיפים

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

מה אתה צריך

• מַחשֵׁב
• עורך טקסט