Γράψτε περιγραφή εργασίας για έναν agent

Περιγράψτε μια αλλαγή που μπορεί να αξιολογηθεί

Το «προσθέστε εξαγωγή δεδομένων πελατών» αφήνει αρκετές αποφάσεις ανοιχτές. Ποιος μπορεί να εξάγει εγγραφές; Ποιες εγγραφές και ποια πεδία περιλαμβάνονται; Τι συμβαίνει όταν αποτυγχάνει ένα αίτημα; Ο agent μπορεί να συμπληρώσει αυτά τα κενά με εύλογες επιλογές. Αυτές οι επιλογές μπορεί και πάλι να είναι λανθασμένες για την επιχείρηση.

Ξεκινήστε από τον χρήστη και το πρόβλημα. Έπειτα περιγράψτε την απαιτούμενη συμπεριφορά. Συμπεριλάβετε τα αποδεικτικά στοιχεία που θα δείξουν αν το αποτέλεσμα είναι αποδεκτό.

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

Χρησιμοποιήστε συγκεκριμένο παράδειγμα

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

Αποτέλεσμα: Ένας υπεύθυνος υποστήριξης μπορεί να κατεβάσει λίστα πελατών.
Ρόλος: Ένας manager στον τρέχοντα οργανισμό.
Δεδομένα: Μόνο ενεργοί πελάτες αυτού του οργανισμού.
Πεδία: Αναγνωριστικό πελάτη, όνομα εταιρείας και κατάσταση λογαριασμού.
Μορφή: UTF-8 CSV με γραμμή κεφαλίδων.
Απορριφθέν αίτημα: Επιστροφή του υπάρχοντος σφάλματος εξουσιοδότησης.
Κενό αποτέλεσμα: Επιστροφή έγκυρου CSV μόνο με την κεφαλίδα.
Έκταση: Χρήση του υπάρχοντος route εξαγωγής και μοτίβου audit.
Εξαιρέσεις: Χωρίς νέους ρόλους, εξαρτήσεις ή deployment.
Αποδεικτικά στοιχεία: Tests για επιτρεπόμενα, απορριφθέντα, κενά αιτήματα και αιτήματα για άλλον οργανισμό.

Αυτή η περιγραφή προσδιορίζει χρήσιμη συμπεριφορά και όρια. Αναδεικνύει επίσης επιπλέον ερωτήματα. Πρέπει το σύστημα να περιορίζει το μέγεθος της εξαγωγής; Μπορεί ένα πεδίο να περιέχει τύπο υπολογιστικού φύλλου; Ποιος μπορεί να αποκτήσει πρόσβαση στην εγγραφή audit; Επιλύστε τα ερωτήματα με ουσιαστικές συνέπειες πριν από την υλοποίηση. Μην αντιμετωπίζετε το παράδειγμα ως καθολική λίστα ελέγχου.

Διαχωρίστε τις απαιτήσεις από τις υποθέσεις

Μια απαίτηση δηλώνει συμπεριφορά που πρέπει να καλύπτει η αλλαγή. Μια υπόθεση είναι ένα στοιχείο που δεν έχετε ακόμη επαληθεύσει. Κρατήστε τα χωριστά.

Για παράδειγμα, το «χρησιμοποιήστε το υπάρχον μοτίβο audit» υποθέτει ότι υπάρχει κατάλληλο μοτίβο. Ζητήστε από τον agent να το βρει. Αν το αποθετήριο δεν έχει τέτοιο μοτίβο, ο agent πρέπει να αναφέρει την εξάρτηση που λείπει πριν επινοήσει νέο σύστημα audit.

Ένας περιορισμός μπορεί επίσης να συγκρούεται με το αποτέλεσμα. Το υπάρχον route μπορεί να επιστρέφει κάθε οργανισμό εκ σχεδιασμού. Ο agent πρέπει να δείξει τη σύγκρουση και να προτείνει περιορισμένη διόρθωση. Δεν πρέπει να αφαιρέσει σιωπηρά το όριο δεδομένων ή να επεκτείνει την εργασία σε επανασχεδιασμό της αρχιτεκτονικής.

Συμπεριλάβετε αποδεικτικά στοιχεία στην ολοκλήρωση

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

Το pull request πρέπει να διατηρεί τον λόγο της αλλαγής. Ένας μελλοντικός συντηρητής μπορεί να δει τον κώδικα χωρίς την αρχική συνομιλία. Συμπεριλάβετε αρκετό πλαίσιο για να εξηγήσετε γιατί η εξαγωγή αποκλείει συγκεκριμένα πεδία και πώς επιβάλλεται ο έλεγχος πρόσβασης.

Οι οδηγίες της Google για περιγραφές αλλαγών είναι χρήσιμη αναφορά για αυτή την καταγραφή. Η περιγραφή πρέπει να εξηγεί την αλλαγή και τον σκοπό της. Κρατήστε την καταγραφή σύμφωνη με την τελική υλοποίηση μετά τις αλλαγές της ανασκόπησης.

Κρατήστε την περιγραφή ανάλογη της εργασίας

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

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