Πώς να γράψετε ένα Readme

Συγγραφέας: Carl Weaver
Ημερομηνία Δημιουργίας: 22 Φεβρουάριος 2021
Ημερομηνία Ενημέρωσης: 28 Ιούνιος 2024
Anonim
MIUI 12 Google Account/FRP Bypass |All Xiaomi Redmi |Without PC
Βίντεο: MIUI 12 Google Account/FRP Bypass |All Xiaomi Redmi |Without PC

Περιεχόμενο

Ένα αρχείο Readme είναι ένα μικρό έγγραφο που συνήθως περιλαμβάνεται σε ένα πρόγραμμα. Τα αρχεία Readme γράφονται από προγραμματιστές λογισμικού και περιέχουν βασικές πληροφορίες σχετικά με ένα πρόγραμμα, συμπεριλαμβανομένων πληροφοριών εγκατάστασης ή οδηγού για τις ρυθμίσεις του συστήματος, στοιχεία επικοινωνίας, άδειας χρήσης, επαίνους και πληροφορίες έκδοσης λογισμικού. Για τη διανομή λογισμικού, είναι σημαντικό να γνωρίζετε πώς να γράφετε το αρχείο Readme. Ένα κακώς γραμμένο Readme μπορεί να είναι απογοητευτικό και κουραστικό για τον χρήστη, ενώ ένα καλό μπορεί να τον βοηθήσει να μάθει εύκολα τις βασικές πληροφορίες για το πρόγραμμά σας.

Βήματα

  1. 1 Συμπεριλάβετε στοιχεία επικοινωνίας. Αυτό είναι ίσως το πιο σημαντικό μέρος του εγγράφου Readme. Τα στοιχεία επικοινωνίας θα επιτρέψουν στον χρήστη να επικοινωνήσει μαζί σας προκειμένου να σας προτείνει να συμπληρώσετε το πρόγραμμα, να κάνετε μια ερώτηση, να διορθώσετε ένα σφάλμα ή να πληρώσετε για το πρόγραμμα. Συμπεριλάβετε το όνομα της εταιρείας, τον ιστότοπο, το email και τον αριθμό τηλεφώνου (αυτές οι πληροφορίες θα χρειαστούν μερικές γραμμές).
    • Ένα παράδειγμα φαίνεται στην εικόνα.
  2. 2 Εισαγάγετε την ημερομηνία στο Readme σας. Αυτό είναι ένα μικρό αλλά πολύ σημαντικό βήμα. Είναι σημαντικό να σημειώσετε την ημερομηνία διανομής για το πρόγραμμά σας. Με αυτόν τον τρόπο, οι χρήστες θα γνωρίζουν τις ενημερώσεις έκδοσης του προγράμματος και θα μπορούν επίσης να καθορίσουν εάν εξακολουθεί να υποστηρίζεται.
  3. 3 Σημειώστε το όνομα, την έκδοση και τις πληροφορίες του προγράμματος. Στο επάνω μέρος, γράψτε το όνομα της εφαρμογής και τον αριθμό έκδοσης. Παρακαλώ γράψτε την τιμή για την πλήρη έκδοση παρακάτω. Εάν διανείμετε το πρόγραμμα χρησιμοποιώντας φυσικά μέσα όπως CD, ενδέχεται να μην συμπεριλάβετε τις πληροφορίες τιμολόγησης, επειδή οι χρήστες πιθανότατα έχουν ήδη πληρώσει για το πρόγραμμα.
  4. 4 Περιγράψτε συνοπτικά το πρόγραμμα. Δώστε μια σύντομη περιγραφή του προγράμματός σας σε μία ή δύο φράσεις. Για παράδειγμα: "Αυτή η εφαρμογή παρακολουθεί τη διάθεση του χρήστη αναλύοντας τη δραστηριότητά του στο Διαδίκτυο και στη συνέχεια αλλάζει το χώρο στην επιφάνεια εργασίας με τέτοιο τρόπο ώστε να προσαρμόζεται στη συναισθηματική κατάσταση του χρήστη."
    • Εάν το λογισμικό σας διαθέτει αρκετά μεγάλο εύρος δυνατοτήτων, μπορείτε να επεκτείνετε την περιγραφή κατά μία ή δύο παραγράφους. Μπορείτε να χρησιμοποιήσετε μια λίστα με κουκκίδες για να αριθμήσετε όλες τις λειτουργίες και τις δυνατότητες του προγράμματος.
  5. 5 Περιγράψτε τις ελάχιστες απαιτήσεις για το πρόγραμμα. Ένα καλό αρχείο Readme πρέπει να περιέχει πληροφορίες σχετικά με τις ελάχιστες απαιτήσεις για το πρόγραμμα και οδηγίες εγκατάστασης. Εάν χρειάζεστε άλλο λογισμικό για να εγκαταστήσετε το πρόγραμμα, φροντίστε να το αναφέρετε. Μπορείτε επίσης να συμπεριλάβετε πληροφορίες σχετικά με τις προτεινόμενες απαιτήσεις (για παράδειγμα, φόρτωση CPU).
  6. 6 Συμπεριλάβετε πληροφορίες άδειας και πνευματικών δικαιωμάτων. Στο τέλος, μην ξεχάσετε να συμπεριλάβετε πληροφορίες σχετικά με την ημερομηνία καθιέρωσης των πνευματικών δικαιωμάτων και την αδειοδότηση του προγράμματος.

Συμβουλές

  • Για να αποτρέψετε τους χρήστες από το να μορφοποιήσουν το αρχείο σας, αποθηκεύστε το σε απλό κείμενο (.txt).
  • Στο όνομα του αρχείου Readme, συμπεριλάβετε το όνομα του προγράμματος. Έτσι, ο χρήστης θα αναζητήσει το αρχείο Readme με το όνομα του προγράμματος.

Τι χρειάζεσαι

  • Υπολογιστή
  • Επεξεργαστής κειμένου