Γρήγορο ξεκίνημα με το στυλ και τη φωνή στο Microsoft Learn

Αυτός ο οδηγός γρήγορης εκκίνησης είναι ένας σύντομος οδηγός για τη σύνταξη τεχνικού περιεχομένου για δημοσίευση στο Microsoft Learn. Αυτές οι οδηγίες ισχύουν είτε δημιουργείτε νέα τεκμηρίωση είτε ενημερώνετε την υπάρχουσα.

Βέλτιστες πρακτικές:

• Ελέγξτε την ορθογραφία και τη γραμματική στα άρθρα σας, ακόμα και εάν πρέπει να τα αντιγράψετε και να τα επικολλήσετε στο Microsoft Word για να κάνετε τους ελέγχους.
• Χρησιμοποιήστε ανεπίσημη και φιλική φωνή, όπως όταν μιλάτε σε κάποιον πρόσωπο με πρόσωπο.
• Χρησιμοποιήστε απλές προτάσεις. Εύκολες στην ανάγνωση προτάσεις σημαίνουν ότι ο αναγνώστης μπορεί γρήγορα να χρησιμοποιήσει τις οδηγίες που κοινοποιείτε.

Χρήση των αρχών φωνής της Microsoft

Επιδίωξή μας είναι να ακολουθούμε αυτές τις αρχές όταν συντάσσουμε τεχνικό περιεχόμενο για το Microsoft Learn. Ίσως να μην τα καταφέρνουμε πάντα, αλλά προσπαθούμε!

• Εστιάστε στον σκοπό του περιεχομένου: Οι πελάτες έχουν κατά νου κάτι συγκεκριμένο όταν συμβουλεύονται την τεκμηρίωσή μας. Πριν ξεκινήσετε να γράφετε, καθορίστε σαφώς ποιος είναι ο πελάτης και τι εργασία προσπαθεί να κάνει. Στη συνέχεια, γράψτε το άρθρο σας για να βοηθήσετε τον συγκεκριμένο πελάτη για τη συγκεκριμένη εργασία.
• Χρησιμοποιήστε καθημερινές λέξεις: Προσπαθήστε να χρησιμοποιήσετε φυσική γλώσσα, τις λέξεις που χρησιμοποιούν οι πελάτες σας. Να είστε λιγότερο επίσημοι, όχι όμως λιγότερο τεχνικοί. Δώστε παραδείγματα που εξηγούν τις νέες έννοιες.
• Γράφετε περιεκτικά και συνοπτικά: Μην σπαταλάτε λέξεις. Να είστε καταφατικοί και να μην χρησιμοποιείτε παραπανίσιες λέξεις ή πολλά προσδιοριστικά. Διατηρήστε τις προτάσεις σύντομες και περιεκτικές. Διατηρήστε το άρθρο εστιασμένο στο θέμα σας. Εάν μια εργασία έχει κάποιο προσδιοριστικό, τοποθετήσετε το στην αρχή της πρότασης ή της παραγράφου. Επίσης, διατηρήστε τον αριθμό των σημειώσεων στο ελάχιστο. Χρησιμοποιήστε ένα στιγμιότυπο οθόνης αν μπορεί να εξοικονομήσει λέξεις.
• Κάντε το άρθρο εύκολο για γρήγορη ανάγνωση: Τοποθετήστε πρώτα τα πιο σημαντικά πράγματα. Χρησιμοποιήστε ενότητες για να χωρίσετε τις μεγάλες διαδικασίες σε πιο διαχειρίσιμα βήματα. (Διαδικασίες με περισσότερα από 12 βήματα είναι πιθανώς πολύ μεγάλες.) Χρησιμοποιήστε ένα στιγμιότυπο οθόνης όταν προσθέτει σαφήνεια.
• Δείξτε συμπάθεια: Χρησιμοποιήστε υποστηρικτικό ύφος στο άρθρο και διατηρήστε τις σημειώσεις περί αποποίησης ευθυνών στο ελάχιστο. Επισημάνετε με ειλικρίνεια περιοχές που ενδεχομένως να προκαλέσουν δυσκολίες στους πελάτες. Βεβαιωθείτε ότι το άρθρο εστιάζει σε ό,τι έχει σημασία για τους πελάτες. Μην γράψετε απλά μια τεχνική πραγματεία.

Εξετάστε το ενδεχόμενο τοπικής προσαρμογής και αυτόματης μετάφρασης

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

• Βεβαιωθείτε ότι το άρθρο δεν περιέχει σφάλματα γραμματικής, ορθογραφίας ή σημείων στίξης: Αυτό είναι κάτι που θα πρέπει να κάνουμε γενικά. Ορισμένα προγράμματα επεξεργασίας Markdown (όπως το MarkdownPad 2.0) διαθέτουν βασικό ορθογραφικό έλεγχο, ωστόσο είναι καλή πρακτική να επικολλάτε την απόδοση περιεχομένου HTML από το άρθρο στο Word, το οποίο έχει ισχυρότερο ορθογραφικό και γραμματικό έλεγχο.
• Κάντε τις προτάσεις σας όσο το δυνατόν πιο βραχείες: Οι σύνθετες προτάσεις ή οι αλυσίδες υποπροτάσεων δυσκολεύουν τη μετάφραση. Διαιρέστε τις προτάσεις εάν μπορείτε χωρίς να δημιουργείτε πλεονασμούς ή μη φυσική ροή λόγου. Δεν θέλουμε άρθρα που έχουν συνταχθεί σε ξύλινη γλώσσα.
• Χρησιμοποιείτε απλή και συνεπή δομή προτάσεων: Η συνέπεια είναι καλύτερη για τη μετάφραση. Αποφεύγετε τις παρενθετικές προτάσεις και κρατήστε το θέμα όσο πιο κοντά γίνεται στην αρχή της πρότασης. Δείτε μερικά δημοσιευμένα άρθρα. Εάν κάποιο άρθρο έχει φιλικό, ευανάγνωστο στυλ, χρησιμοποιήστε το ως μοντέλο.
• Χρησιμοποιείτε συνεπή διατύπωση και πεζά-κεφαλαία: Και πάλι, η συνέπεια είναι το κλειδί. Μην χρησιμοποιείτε κεφαλαία για μια λέξη αν δεν βρίσκεται στην αρχή μιας πρότασης ή αν δεν είναι κύριο όνομα.
• Συμπεριλάβετε τις "μικρές λέξεις": Οι λέξεις που θεωρούμε μικρές και ασήμαντες στα Αγγλικά επειδή εννοούνται από το συγκείμενο (όπως το "a," "the," "that" και "is") είναι κρίσιμες για την αυτόματη μετάφραση. Πρέπει να τις συμπεριλαμβάνετε.

Άλλα ζητήματα για το στυλ και τη φωνή που χρήζουν προσοχής

• Μην διασπάτε τα βήματα με σχολιασμό ή παρενθέσεις.
• Για τα βήματα που περιλαμβάνουν τμήματα κώδικα, βάλτε πρόσθετες πληροφορίες σχετικά με το βήμα μέσα στον κώδικα με τη μορφή σχολίων. Αυτό μειώνει την ποσότητα του κειμένου που οι χρήστες χρειάζεται να διαβάσουν. Οι βασικές πληροφορίες αντιγράφονται στο έργο κώδικα ως υπενθύμιση στους χρήστες για το τι κάνει ο κώδικας σε περίπτωση που ανατρέξουν σε αυτές αργότερα.
• Χρησιμοποιείτε κεφαλαία για το πρώτο γράμμα των λέξεων σε όλους τους τίτλους και τις επικεφαλίδες.
• Στα Αγγλικά, χρησιμοποιείτε τη φράση "sign in" και όχι "log in."
• Για περισσότερες οδηγίες, ανατρέξτε στον Οδηγό στυλ γραφής της Microsoft.

Μεταφρασμένη τεκμηρίωση

• Εάν συμφέρετε σε μεταφρασμένο υλικό τεκμηρίωσης, ανατρέξτε στις αναφορές παγκοσμιοποίησης.
• Για οδηγίες σχετικά με την τοπική προσαρμογή, για πληροφορίες σχετικά με την υφολογία της γλώσσας και τη χρήση σε δημοσιεύσεις τεχνικού περιεχομένου, καθώς επίσης για πληροφορίες σχετικά με τις μορφές δεδομένων για συγκεκριμένη αγορά, κάντε λήψη του υφολογικού οδηγού στη γλώσσα σας.
• Επισκεφθείτε την Ορολογία της Microsoft για να αναζητήσετε εγκεκριμένη ορολογία για συγκεκριμένο προϊόν ή για να κάνετε λήψη της συλλογής ορολογίας της Microsoft στη γλώσσα σας.
• Για να μάθετε περισσότερα για την τοπική προσαρμογή, ανατρέξτε στην ενότητα "Παγκόσμιες επικοινωνίες" στον Οδηγό στυλ γραφής της Microsoft.

Σημείωμα

Η πιο μεταφρασμένος τεκμηρίωση δεν παρέχει τη δυνατότητα επεξεργασίας ή παροχής σχολίων μέσω του GitHub. Για να παρέχετε σχόλια σχετικά με μεταφρασμένο περιεχόμενο, χρησιμοποιήστε τη https://aka.ms/provide-feedback φόρμα.