Σχεδιασμός ροών εργασιών σχεδίασης εγγράφων

Πώς να γράψετε ένα έργο README που ενισχύει τη συνοχή και την παραγωγικότητα της ομάδας σχεδιασμού.

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

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

Γιατί να γράψετε ένα σχέδιο README;

Κάθε σχεδιαστής έχει έναν κάπως μοναδικό και ιδιοσυγκρασιακό τρόπο εργασίας. Οι ρυθμίσεις του λογισμικού μας ποικίλλουν, διαρθρώνουμε διαφορετικά τα αρχεία μας, μερικοί από εμάς είναι εντάξει με ονόματα στρώσεων όπως το Rectangle 17 copy 4, άλλα όχι τόσο. Ενώ οι αποκλίσεις στον τρόπο που δουλεύουμε δεν έχουν σημασία τόσο πολύ όταν είμαστε μοναχικοί λύκοι, γίνονται γρήγορα επακόλουθο όταν δουλεύουμε σε ένα περιβάλλον ομάδας ή όταν το προσωπικό ανακατεύει και κάποιος πρέπει να πάρει το έργο κάποιου άλλου. Σε αυτά τα αναπόφευκτα σενάρια, αισθανόμαστε σύντομα τον πόνο είτε να επιλύσουμε τη λογική του τρόπου εργασίας κάποιου άλλου, είτε να χάνουμε χρόνο να τροποποιήσουμε το έργο τους για να ευθυγραμμιστούμε με την υπάρχουσα μυϊκή μνήμη μας ή για να καθαρίσουμε το έργο που τέθηκε μαζί ελάχιστα στην πρώτη θέση, αλλά πρέπει να γίνει επαναχρησιμοποιήσιμη.

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

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

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

Το σχεδιαστικό μας πλαίσιο README

Έτσι, τι περιλαμβάνει το README προσανατολισμένο στο σχεδιασμό; Αυτό πιθανόν να είναι διαφορετικό για κάθε ομάδα και έργο, αλλά παρακάτω είναι ένα πλαίσιο που είχαμε επιτυχία με το Livefront. Παρέχουμε ένα παράδειγμα στο τέλος αυτού του άρθρου.

ΠΤΥΧΙΑΚΗ ΕΡΓΑΣΙΑ

Ξεκινήστε με μια σύνοψη μιας φράσης του προϊόντος ή του χαρακτηριστικού και την ανθρώπινη ανάγκη που εξυπηρετεί. Κρατήστε το γερό αλλά αρκετά λεπτομερές για κάποιον που είναι νέος στην ιδέα να πιάσει αμέσως την ιδέα. Αυτό μπορεί να είναι μια βασική περίπτωση χρήσης ή δουλειά που πρέπει να γίνει, ή απλώς ένα καλό παλιομοδίτικο γήπεδο ανελκυστήρα. Αυτό που δεν είναι είναι ένα σύνθημα ή μια ετικέτα. πρέπει να είναι συγκεκριμένη και αρκετά λεπτομερής ώστε να αποκτήσει αμέσως την ιδέα. Κάποια έμπνευση μπορεί να βρεθεί στα αρχεία καταγραφής Οι σεναριογράφοι έχουν χρησιμοποιήσει εδώ και καιρό τα σενάρια τους, όπως αυτό για τον Τιτανικό του James Cameron: "Ένας νεαρός άνδρας και γυναίκα από διαφορετικές κοινωνικές τάξεις ερωτεύονται σε ένα κακόβουλο ταξίδι στη θάλασσα". με λίγα λόγια, έχετε μια διαισθητική αίσθηση του ποιος είναι για και για τι είναι. Μια καλή δήλωση προϊόντος ή χαρακτηριστικού κάνει το ίδιο πράγμα: σας λέει κάτι που έχει νόημα για το ποιος θέλει το πράγμα που κάνετε και γιατί.

Για να εφαρμόσετε αυτήν την έννοια, ας πάρουμε το παράδειγμα του Lyft. Μια διατριβή για τη ναυαρχίδα του app app θα μπορούσε να είναι: "Η Lyft σας επιτρέπει να βρείτε μια φιλική και οικονομικά προσιτή βόλτα όποτε χρειάζεται, με το πάτημα ενός κουμπιού." (Πράγματι, να είναι ένα εξαιρετικό μέρος για να αναζητήσετε υλικό διατριβής εάν εργάζεστε σε μια εφαρμογή για κινητά.) Αυτό είναι πολύ καλό, αλλά η Lyft έχει μια μεγάλη ομάδα σχεδιασμού και η δουλειά της πιθανότατα διαδίδεται σε διάφορα διακριτά χαρακτηριστικά και περιοχές εστίασης. Ας υποθέσουμε ότι μια ομάδα σμήνους αφιερωμένη στα χαρακτηριστικά προγραμματισμού της Lyft έχει γράψει το δικό της README. Μπορεί να τους διαβάσει κάτι σαν: "Για τις περιόδους που πρέπει να σχεδιάσετε μπροστά, ο προγραμματισμός Lyft σας επιτρέπει να κρατάτε εύκολα μια φιλική και προσιτή βόλτα εκ των προτέρων, ώστε να μπορείτε να φτάσετε εκεί που χρειάζεται να πάτε, χωρίς κόπο." λίγο. Θέλετε να αποστάξετε την αξία του πυρήνα ό, τι επεξεργάζεστε στην ουσία του, με αρκετή εξειδίκευση για να ζωγραφίσετε μια καθαρή ψυχική εικόνα.

Συμβουλή: Για τις ομάδες που είναι οργανωμένες γύρω από τις θέσεις εργασίας που πρέπει να γίνουν, η διατριβή σας είναι πιθανόν να βρίσκεται εκεί στη δήλωση εργασίας: "Όταν [x], το [προϊόν / χαρακτηριστικό] σας βοηθά [y]. "

Ρύθμιση

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

  • Λογισμικό: ποιες εφαρμογές γραφείου χρησιμοποιεί η ομάδα για 2D σχεδιασμό, 3D σχεδιασμό, πρωτότυπο ή / και μεταβίβαση προγραμματιστών και ποια έκδοση;
  • Plugins: Ποιες (αν υπάρχουν) προσθήκες ή επεκτάσεις απαιτούνται;
  • Βιβλιοθήκες: ποιες βιβλιοθήκες συμβόλων ή εξαρτημάτων πρέπει να συνδεθούν και πού υπάρχει η μόνη πηγή αλήθειας για κάθε ζωντανό κόσμο; Υπάρχουν αντίστοιχες οδηγίες συστήματος σχεδιασμού που τεκμηριώνονται κάπου;
  • Γραμματοσειρές: ποιες γραμματοσειρές γραμματοσειρών ή γραμματοσειρών πρέπει να εγκατασταθούν και πού βρίσκονται αυτά τα στοιχεία;
  • Master File: ποιο (αν υπάρχει) κύριο αρχείο ή πρότυπο θα πρέπει να είναι διακλαδισμένο ως σημείο εκκίνησης για επανάληψη;

Επιπλέον, μπορεί να είναι λογικό να συμπεριληφθούν οι ρυθμίσεις λογαριασμού ή οι οδηγίες σύνδεσης για τυχόν υπηρεσίες cloud που χρησιμοποιείτε για βασικές ροές εργασίας, όπως αποθήκευση αρχείων, έλεγχος εκδόσεων ή ακόμα και σχεδιασμό UI ( Figma). Αν σχεδιάζετε με ζωντανά δεδομένα JSON, συνδέστε ή συμπεριλάβετε οδηγίες για το χτύπημα των σχετικών παραμέτρων API.

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

Ονομασία & Έκδοση

Για ομάδες που χειρίζονται μη αυτόματα αρχεία και εκδόσεις, χρησιμοποιήστε αυτήν την τεκμηρίωση για να καταγράψετε εγγράφως τις συμβάσεις ονομασίας αρχείων. Για να μετριάσετε αποτελεσματικά το χάος των αρχείων, οι οδηγίες σχετικά με την ονομασία και την έκδοση πρέπει να περιλαμβάνουν μερικά πράγματα:

  • Η βασική δομή ενός αρχείου με σωστή ονομασία (π.χ. "[YYYYMMDD] - [Περιγραφή] [Έκδοση] .xyz")
  • Το μοντέλο έκδοσης που χρησιμοποιείται για την παρακολούθηση των συνεχών εργασιών (π.χ. "3.0", "Rev 4a", "Ιούλιος 2018"). Αυτό μπορεί να ευθυγραμμιστεί με το μοντέλο απελευθέρωσης που χρησιμοποιείται από την ευρύτερη οργάνωση προϊόντων ή μπορεί να απομακρυνθεί πλήρως και να είναι μοναδικό για την ομάδα σχεδιασμού.
  • Οι συνθήκες διακλάδωσης ή πότε να σπάσει ένα νέο αρχείο και να αυξήσει την έκδοση. Αυτό μπορεί να καθοριστεί με βάση το εύρος των αλλαγών, την απελευθέρωση μιας νέας κατασκευής ή το πέρασμα ενός ορισμένου χρονικού διαστήματος.

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

Ροή εργασιών

Ρυθμίστε τη ροή εργασίας υψηλού επιπέδου και καθορίστε τα εργαλεία που χρησιμοποιούνται για το τι. Οι ομάδες σχεδιασμού τείνουν να εργάζονται σε μια αρκετά συνεπή ακολουθία ή κύκλο, με διαφορετικά εργαλεία που αντιστοιχούν σε κάθε στάδιο:

  • Η ιδέα: η αρχική φάση της έρευνας και της ιδέας. Τα εργαλεία που χρησιμοποιούνται σε αυτό το στάδιο ενδέχεται να περιλαμβάνουν λευκούς πίνακες και Camera.app, Invision Freehand ή Dropbox Paper.
  • Εμπειρία & Οπτικός Σχεδιασμός: το σχέδιο και η σύνθεση σε διάφορα επίπεδα πιστότητας που αποτελούν το μεγαλύτερο μέρος της εργασίας παραγωγής. Για τις περισσότερες ομάδες, αυτό είναι το Sketch, το Figma ή το Framer X.
  • Πρωτότυπο: η διαδραστική απόδοση των σχεδίων σχεδιασμού για δοκιμές, επίδειξη και μεταβίβαση. Αυτός είναι πιθανώς ένας συνδυασμός εργαλείων που κυμαίνονται από απλούστερες επιλογές, όπως το InVision, σε πιο ισχυρές επιλογές όπως η αρχή, ο Framer ή το Origami.
  • Συνεργασία: ο κύκλος ανάδρασης, επικοινωνίας και επανάληψης. Το InVision, το Sketch Cloud και το Zeplin είναι δημοφιλή εργαλεία για αυτό το κομμάτι.
  • Handoff: το στάδιο στο οποίο τα αντικείμενα σχεδιασμού μεταβιβάζονται στην ομάδα dev για υλοποίηση. Zeplin και InVision οδηγούν το πακέτο εδώ αλλά άλλα εργαλεία όπως το Avocode και η Gallery είναι εκεί έξω.

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

Συμβουλή: Να είναι σαφής ο τρόπος με τον οποίο κάθε εργαλείο πρέπει και δεν πρέπει να χρησιμοποιείται, ιδιαίτερα όταν υπάρχουν επικαλύψεις στη λειτουργικότητα. Για παράδειγμα, αν χρησιμοποιείτε InVision για συνεργασία και Zeplin για μεταβίβαση, διευκρινίστε ότι το χαρακτηριστικό σχολιασμού της Zeplin δεν θα πρέπει να χρησιμοποιείται για να συλλάβει ανατροφοδότηση σχεδίασης και μόνο οι τελικές, έτοιμες για παραγωγή, complies θα πρέπει να δεσμεύονται στη Zeplin.

Στυλ

Καθιέρωση συμβόλων στυλ για τα αρχεία εργασίας σας παρόμοια με τον τρόπο με τον οποίο ένας οδηγός στυλ προγραμματιστή μπορεί να καθορίσει προσεγγίσεις σε πράγματα όπως ορισμός και οριοθέτηση αντικειμένων. Οι ερωτήσεις που πρέπει να απαντηθούν περιλαμβάνουν:

  • Δομή: πώς οι σελίδες ονομάζονται, αριθμούνται και χρησιμοποιούνται; Πώς, αν είναι καθόλου, υπάρχουν διαφορετικά χαρακτηριστικά που χωρίζονται σε πολλαπλά αρχεία εργασίας; Ποιο είναι το μέγιστο κατάλληλο εύρος ενός αρχείου;
  • Artboard Naming: πώς είναι οι ατομικοί πίνακες τέχνης που ονομάζονται και αριθμούνται και ποιες είναι οι συμβάσεις για να δηλώσουν τις σχέσεις κράτους και γονέα-παιδιού;
  • Υγιεινή στρώσεων: πώς ονομάζονται, ταξινομούνται και / ή ομαδοποιούνται μεμονωμένα στρώματα και σύμβολα; Πώς πρέπει να τοποθετηθούν τα σύμβολα; Οι διαδρομές εξαγωγής περιουσιακών στοιχείων ορίζονται μέσω της ιδιότητας του ονόματος στρώματος;
  • Mapping ροής: πώς απεικονίζονται οι ενέργειες και οι σχέσεις οθόνης;
  • Συσκευές: Ποιο είναι το προεπιλεγμένο μέγεθος οθόνης που έχει σχεδιαστεί για και τι πρέπει να επικυρωθεί για τυχόν πρόσθετες αναλύσεις;
  • Διαχωρισμός: πώς πρέπει να τοποθετηθούν και να σπάσουν τα στρώματα; Υπάρχει ένα τυποποιημένο πλέγμα και, αν ναι, πού βρίσκονται αυτές οι κατευθυντήριες γραμμές;
  • Περιορισμοί: ποιες είναι οι προσδοκίες όσον αφορά τους περιορισμούς και την δυνατότητα αλλαγής μεγέθους; Αυτό επιβάλλεται σε επίπεδο συμβόλων ή σε παγκόσμιο επίπεδο σε όλους τους πίνακες τέχνης;
  • Ρυθμίσεις εξαγωγής: πώς πρέπει να ρυθμιστούν οι προεπιλεγμένες ρυθμίσεις εξαγωγής για τα κομμάτια και τους πίνακες τέχνης σε φέτες;

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

Αποφασιστές

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

Εμπειρογνώμονες

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

Συμβουλή: αν είχατε την επόμενη εβδομάδα να κρατάτε ένα σπριντ σχεδιασμού τύπου GV, αυτοί είναι οι άνθρωποι που θα προσκαλέσετε στο τμήμα "Ζητήστε τους ειδικούς" της Ημέρας 1.

Αποτελέσματα

Τέλος, είναι καλή ιδέα να διευκρινιστούν τα αποτελέσματα με τα οποία θα εκτιμηθεί η απόδοση της ομάδας. Αυτές μπορεί να είναι ημερομηνίες και ορόσημα, βασικές μετρήσεις, OKRs, ή οποιοδήποτε άλλο αποτέλεσμα είναι υπεύθυνο να παραδώσει η ομάδα. Είναι συχνά δυναμικές και μπορεί να ζουν στη δική τους θέση σαν ένα φύλλο Google ή χώρος Confluence, οπότε η σύνδεση με αυτές είναι το μόνο που χρειάζεται. Η ιδέα είναι απλώς να παράσχει αρχικό πλαίσιο για τον τρόπο μέτρησης της επιτυχίας και τον τρόπο λήψης αποφάσεων. Σκεφτείτε αυτό ως ένα bookend για τη δήλωση διατριβή? η διατριβή καταγράφει το πρόβλημα που πρέπει να επιλυθεί και τα αποτελέσματα είναι βαρόμετρα για τη μέτρηση της αποτελεσματικότητας της λύσης.

Πώς να αξιοποιήσετε στο έπακρο το README

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

  • Κρατήστε το σφιχτό: γράφετε ένα README, όχι ένα μυθιστόρημα. Αναφέρετε λεπτομερώς τα πράγματα που έχουν σημασία, αλλά και σαφή και συνοπτική. Και πάλι, η ιδέα είναι ότι κάποιος που είναι νέος στο σχέδιό σας (ή κάποιος που χρειάζεται απλά μια περιστασιακή ανανέωση) μπορεί να πάρει τα ρουλεμάν τους γρήγορα. Όσο πιο μακρύ και πιο πυκνό είναι το έγγραφό σας, τόσο λιγότεροι είναι οι συνάδελφοί σας να διαβάζουν, να εσωτερικεύουν και να επιστρέφουν σε αυτό.
  • Οι σύνδεσμοι είναι φίλοι σας: αν υπάρχουν ορισμένα τμήματα που είναι ιδιαίτερα μακρά ή / και πολύ επαναχρησιμοποιήσιμα - σκεφτείτε τους οδηγούς στυλ, τα πλαίσια εκδόσεων, τους κώδικες δεοντολογίας - συνδέστε με μια κανονική περίπτωση. Αυτό κρατά το έγγραφο πληροφορίες πυκνό αλλά ελαφρύ, και κάνει μια εύχρηστη αναφορά για όποιον προσπαθεί να παρακολουθήσει αυτές τις συνδέσεις στο μέλλον.
  • Μην επαναλάβετε τον εαυτό σας: ένα έργο README θα πρέπει να έχει μία μόνο πηγή αλήθειας και δεν πρέπει να αναπαράγεται. Οι προγραμματιστές αποθηκεύουν το δικό τους στον ριζικό κατάλογο της αποθήκης έργου. Η δική σας μπορεί να ζει σε ένα φάκελο Dropbox, σε ένα χώρο εργασίας Notion ή ως Έγγραφο Google. Ό, τι κι αν κάνετε, μην τις ενσωματώσετε απευθείας στα αρχεία εργασίας σας, καθώς αυτό οδηγεί αναπόφευκτα σε επικαλύψεις και αποκλίσεις.
  • Μείνετε ενημερωμένοι: τα προγράμματα λογισμικού δεν είναι στατικά και δεν πρέπει να είναι και η τεκμηρίωσή τους. Όταν εστιάζετε το προϊόν ή το χαρακτηριστικό που εργάζεστε σε αλλαγές, θα πρέπει και η γραπτή εργασία. Όταν οι γροθιές μετακινούνται, θα πρέπει και τα δηλωμένα αποτελέσματα. Όταν η ομάδα σας ενημερώνει μια νέα έκδοση του Sketch, οι οδηγίες εγκατάστασης πρέπει να αντανακλούν αυτό. Το README σας είναι ένα ζωντανό πράγμα, ακριβώς όπως η ομάδα, τα εργαλεία, το έργο και η αγορά.

Γράφοντας και διατηρώντας ένα έργο το README μπορεί να φαίνεται σαν πονοκέφαλος, αλλά δεν χρειάζεται να πάρει έναν τόνο χρόνου και τα οφέλη σύνθετα μακροπρόθεσμα. Για να σας ξεκινήσουμε, δώσαμε το παρακάτω παράδειγμα για να το αντιγράψετε ως αναφορά. Μπορείτε να χρησιμοποιήσετε, remix και να το μοιραστείτε. Καθώς μαθαίνετε τι λειτουργεί καλά για την ομάδα σας και τι όχι, θα θέλαμε να ακούσουμε αυτά τα ευρήματα. Αφήστε μια απάντηση στο Medium ή tweet μας (είμαστε @Livefront) ... είμαστε ανυπόμονοι να ακούσουμε πώς πηγαίνει!

Μήπως σας αρέσει αυτό το άρθρο; Αν ναι, ενημερώστε μας, μοιραστείτε το και πατήστε και κρατήστε πατημένο το κουμπί "χτύπημα" παρακάτω! Θέλετε περισσότερο σαν αυτό; Ακολουθήστε μας στο Medium και στο Twitter στο @Livefront. Επίσης, προσλαμβάνουμε!