Γράφοντας καλύτερα email

Ηλεκτρονική αλληλογραφία - Συμβουλές για την σύνταξη αποτελεσματικών email αποφεύγοντας παρανοήσεις, με παραδείγματα από τον κόσμο της πληροφορικής.
This article is also available in english.
Πρόσθεσα νέα σελίδα στο μπλογκ: "Αστεία" για προγραμματιστές

Η Ηλεκτρονική Αλληλογραφία (email) δεν είναι η αγαπημένη μου αλλά αφού δεν μπορώ να την αποφύγω, προσπαθώ να συντάξω τα μηνύματα με τέτοιο τρόπο που νομίζω ότι διευκολύνει και εμένα αλλά και τον παραλήπτη:

  • να εντοπίσει γρήγορα και εύκολα τι προσπαθώ να επικοινωνήσω
  • να αποφευγχθούν παρανοήσεις
  • να γλιτώσουμε χρόνο

Παραθέτω κάποιες συμβουλές. Δεν ισχύουν για όλα τα email, παρέχω πριν και μετά παραδείγματα για να περιγράψω καλύτερα την κάθε περίπτωση.

Έμφαση τμημάτων με έντονη γραμματοσειρά ή υπογραμμιση

Δίνοντας έμφαση στα κατάλληλα τμήματα ενός μηνύματος, ειδικά αν είναι μαρκοσκελές, βοηθάτε τους αναγνώστες να πάρουν γρήγορα μια ιδέα σχετικά με το τι αφορά το email και να εντοπίσουν εύκολα τα σημαντικά στοιχεία ξαναδιαβάζοντας το μήνυμα στο μέλλον.

Παράδειγμα

Πριν

Καλησπέρα σε όλους,

Παρατήρησα πολλά logs σχετικά με ...μπλα μπλα... τις τελευταίες μέρες και δε νομίζω να είναι φυσιολογικό. Πιστεύω ότι το πρόβλημα είναι στην ανανέωση του gem ...μπλα μπλα...

Άνοιξα ένα issue περιγράφοντας την περίπτωση στο Redmine (#455) στην τρέχουσα έκδοση.
Αν επιθυμείτε αλλάξτε την προτεραιότητα ..μπλα μπλα...

Ευχαριστώ,
Λάζαρος

Μετά

Καλησπέρα σε όλους,

Παρατήρησα πολλά logs σχετικά με ...μπλα μπλα... τις τελευταίες μέρες και δε νομίζω να είναι φυσιολογικό. Πιστεύω ότι το πρόβλημα είναι στην ανανέωση του gem ...μπλα μπλα...

Άνοιξα ένα issue περιγράφοντας την περίπτωση στο Redmine (#455) στην τρέχουσα έκδοση.
Αν επιθυμείτε αλλάξτε την προτεραιότητα ..μπλα μπλα...

Ευχαριστώ,
Λάζαρος

Χρήση συγκεκριμένων ημερομηνιών αντί για χτες, αύριο κ.λπ.

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

Παράδειγμα

Πριν

Αγαπητό QA,

Χτες ανεβάσαμε ένα fix για το λάθος #455 στο staging περιβάλλον και σκοπεύουμε να το ανεβάσουμε στην παραγωγή την επόμενη Δευτέρα αν μας δώσετε το πράσινο φως μέχρι άυριο - τέλος ημέρας.

Ευχαριστώ,
Λάζαρος

Μετά

Αγαπητό QA,

Χτες, 25/06/2019 ανεβάσαμε ένα fix για το λάθος #455 στο staging περιβάλλον και σκοπεύουμε να το ανεβάσουμε στην παραγωγή την επόμενη Δευτέρα, 01/07/2019 αν μας δώσετε το πράσινο φως μέχρι αύριο 27/06/2019 - τέλος ημέρας.

Ευχαριστώ,
Λάζαρος

Χρήση συνδέσμων για αναφορές

Χρησιμοποιήστε συνδέσμους όταν αναφέρεστε σε κάτι που δυνητικά θα απαιτήσει από τον παραλήπτη να το ψάξει σε κάποιο άλλο σύστημα.

Η χρήση συνδέσμων έχει δύο πλεονεκτήματα:

  • Εξοικονόμηση χρόνου
  • Εξάλειψη ασαφών αναφορών

Παράδειγμα

Πριν

Αγαπητή Φοίβη,

Δεν κατάλαβα τη διαδικασία που περιγράφεται στο issue με το λάθος στα logs. Ούτε το σχόλιο της Ίριδας ήταν ξεκάθαρο. Μπορείς να με βοηθήσεις;

Ευχαριστώ,
Λάζαρος

Μετά

Αγαπητή Φοίβη,

Δεν κατάλαβα τη διαδικασία που περιγράφεται στο issue με το λάθος στα logs (Redmine #453). Ούτε αυτό το σχόλιο της Ίριδας ήταν ξεκάθαρο. Μπορείς να με βοηθήσεις;

Ευχαριστώ,
Λάζαρος

Δομήστε τα μακροσκελή μηνύματα

Τα μεγάλα email σε γενικές γραμμές δεν είναι πολύ αποτελεσματικά και πολλά τμήματα τους είναι επιρρεπή στο να αγνοηθούν.

Όταν πρέπει να συντάξω τέτοιου είδους μηνύματα, προσπαθώ να κατηγοριοποιήσω το κείμενο εννοιολογικά σε τμήματα χρησιμοποιώντας επικεφαλίδες και παραγράφους επιτρέποντας στους αναγνώστες να τα εντοπίσουν με μια ματιά.

Παράδειγμα

Πριν

Αγαπητή ομάδα,

Την προηγούμενη εβδομάδα είχαμε ένα πρόβλημα με τα logs στην παραγωγή. Αναφέρομαι στο Redmine issue #453. Παρατηρήσαμε μια τεράστια αύξηση στα μηνύματα που καταγράφονται ... οδηγώντας σε καθυστερημένες αποκρίσεις λόγω του ... Σε κάποιο σημείο ο server ξέμεινε από δίσκο και άρχισε να καταρρέει το σύμπαν ... Αρχίσαμε τη διερεύνηση για το τι μπορεί να συμβαίνει αμέσως και μετά από δύο μέρες καταφέραμε να αναπαράγουμε το πρόβλημα και στο staging περιβάλλον. Το πρόβλημα ήταν η χρήση μιας εξωτερικής βιβλιοθήκης που είχε ένα bug που ... Αφαιρέσαμε την βιβλιοθήκη και το λάθος έπαψε να εμφανίζεται στο staging περιβάλλον. Η buggy βιβλιοθήκη ήταν ... Ανεβάσαμε ένα fix στες και όλα μοιάζουν να έχουμε επιστρέψει στο φυσιολογικό. Επίσης προσθέσαμε κάποια script που θα μας ενημερώσουν άμεσα αν κάτι αντίστοιχο αρχίζει να συμβαίνει ξανά στο μέλλον.

Ευχαριστώ για το χρόνο σας,
Λάζαρος

Μετά

Αγαπητή ομάδα,

Το πρόβλημα
Την περασμένη εβδομάδα είχαμε ένα **πρόβλημα με τα logs στην παραγωγή**. Παρατηρήσαμε μια τεράστια αύξηση στα μηνύματα ...

Συνέπειες
Η αύξηση στα μηνύματα οδήγησε σε καθυστερημένες αποκρίσεις ... Σε κάποιο σημείο ο server **ξέμεινε από δίσκο και όλα άρχισα να καταρρέουν** ...

Αιτία του προβλήματος
Αρχίσαμε άμεσα τη διερεύνηση και καταφέραμε να αναπαράγουμε το πρόβλημα και στο staging περιβάλλον.
Το πρόβλημα ήταν η χρήση μιας **εξωτερικής βιβλιοθήκης** που είχε ένα bug ... Η βιβλιοθήκη ήταν η ...

Ενέργειες που πραγματοποιήθηκαν

1. Αφαιρέσαμε τη βιβλιοθήκη και το λάθος δεν ήταν πια παρόν στο staging περιβάλλον.
2. Οι διαχειριστές κράτησαν backup των logs και κατόπιν τα αφαίρεσαν ...
3. Ανεβάσαμε το fix στην παραγωγή χτες, 26/06/2019.
4. Επίσης, προσθέσαμε κάποια scripts που θα μας ειδοποιήσουν εγκαίρως σε περίπτωση που αντίστοιχο πρόβλημα αρχίσει να εμφανίζεται στο μέλλον.

Τρέχουσα κατάσταση στην παραγωγή
Ο server τρέχει κανονικά, όλα έχουν επιστρέψει στο φυσιολογικό.

Περισσότερες πληροφορίες
Σχετικό Redmine issue #453
Εξωτερική βιβλιοθήκη - Επίσημη αναφορά του bug

Ευχαριστώ για το χρόνο σας,
Λάζαρος

Να είστε συγκεκριμένοι/ες στο τι ζητάτε από ποιον

Έχω δει πάρα πολλές φορές emails για τα οποία:

  • ο αποστολέας ήθελε κάτι από κάποιον
  • οι παραλήπτες
    • δεν θεωρούσαν ότι ήταν αυτοί που πρέπει να παρέχουν το κάτι
    • κατάλαβαν το κάτι σαν κάτι άλλο από αυτό που εννοούσε ο αποστολέας

Προσπαθώ να είμαι πολύ συγκεκριμένος και να παρέχω λεπτομέρειες (όπου είναι δυνατόν) σχετικά με το τι χρειάζομαι και όταν υπάρχουν παραπάνω του ενός παραλήπτες, αναφέρομαι στον καθένα αποκλειστικά χρησιμοποιώντας το παπάκι: @

Παράδειγμα

Πριν

Αγαπητοί,

Έχω σπρώξει ένα commit που πιθανότατα λύνει το bug με τα logs στο staging. Δε θα είμαι εδώ αύριο οπότε μπορείτε να κάνετε review και να το ανεβάσετε αν είναι εντάξει;

Ευχαριστώ.

Μετά

Αγαπητοί,

Έσπρωξα ένα commit που πιθανότατα λύνει το bug (Redmine #453) με τα logs στο staging περιβάλλον.

Εφόσον δε θα είμαι εδώ αύριο, 27/06/2019, μπορείτε παρακαλώ:

@καπετάνιος: review το commit
@qa: να τρέξετε τη σουίτα για να επαληθεύσετε το fix
@devs: προχωρήσετε το ανέβασμα του fix στην παραγωγή στις 28/06/2019 δεδομένου ότι πήραμε το OK από την QA ομάδα?

Ευχαριστώ,
Λάζαρος

Αυτά, ευχαριστώ για την ανάγνωση,

Λάζαρος

Υστερόγραφο

Βρείτε συνημμένη φωτογραφία από τις γάτες μου.

Όταν ακούνε τη λέξη 'ηλεκτρική σκούπα'

Σχόλια
Για σχόλια, feedback, λάθη κ.λπ. παρακαλώ Χρησιμοποιήστε αυτό το GitHub issue.
Ευχαριστώ!