Η μέση εταιρεία πληροφορικής έχει απαιτήσεις, ιστορικό εργασιών παρακολούθησης, πηγές (ίσως και με σχόλια στον κώδικα), οδηγίες για τυπικές, σημαντικές και περίπλοκες υποθέσεις στην παραγωγή, περιγραφή επιχειρηματικών διαδικασιών (από την επιβίβαση έως το «πώς να πάτε διακοπές ”), επαφές, κλειδιά πρόσβασης, λίστες ατόμων και έργων, περιγραφές περιοχών ευθύνης - και ένα σωρό άλλες γνώσεις που μάλλον ξεχάσαμε και οι οποίες μπορούν να αποθηκευτούν στα πιο εκπληκτικά μέρη.
Γνώση =/= τεκμηρίωση. Αυτό δεν μπορεί να εξηγηθεί, πρέπει να το θυμόμαστε
Πώς να βεβαιωθείτε ότι όσοι πρέπει να μάθουν κάτι από αυτό καταλαβαίνουν πού και πώς να το βρουν, και όλοι όσοι πρέπει να γνωρίζουν μεμονωμένα πράγματα και συμφωνίες μπορούν να μάθουν αμέσως και με ακρίβεια για τις αλλαγές σε αυτά.
Στο τελευταίο επεισόδιο του podcast "Team Lead Will Call", τα παιδιά από το Skyeng μίλησαν για τη διαχείριση γνώσης με τον Igor Ο Tsupko είναι ένα άτομο στην επιτροπή προγράμματος KnowledgeConf και ο «διευθυντής του αγνώστου» στο Flant.
Η πλήρης ηχογράφηση είναι διαθέσιμη ως , και παρακάτω έχουμε συλλέξει μερικές ενδιαφέρουσες συμβουλές και συνδέσμους προς χρήσιμο υλικό που αναφέρθηκαν στον ήχο ή επεκτείνουμε τις πληροφορίες από αυτό. Θα ήταν υπέροχο αν μοιραστείτε και τα κόλπα και τα κόλπα της ομάδας σας στα σχόλια.
Πρώτο hack: δεν χρειάζεται πλέον να ξέρετε σε ποιο σύστημα να κοιτάξετε
«Πήρα τις πηγές γνώσης μας και έκανα μια γενική αναζήτηση για αυτές: ένα ενιαίο παράθυρο με σύστημα φιλτραρίσματος για μείωση της περιοχής αναζήτησης. Ναι, ταυτόχρονα, πρέπει ακόμα να παρακολουθείτε την ποιότητά του, να αναπληρώσετε τη βάση γνώσεων και να καταπολεμήσετε τις αλληλεπικαλύψεις και τις εσφαλμένες πληροφορίες.
Ένα κομμάτι χαρτί για να βρεις αυτό είναι όλο
Αλλά ήδη, περίπου το 60% των μηχανικών Flant χρησιμοποιούν αυτήν την αναζήτηση τουλάχιστον 1-2 φορές την ημέρα - και συνήθως βρίσκουν απαντήσεις στην πρώτη ή τη δεύτερη θέση. Και με τη μορφή απόδειξης της ιδέας είναι η ευρετηρίαση των εγγράφων της Google: όλα τα dox, οι φάκελοι, οι μονάδες φορτηγών και ούτω καθεξής - όλα αυτά οδηγούνται επίσης εύκολα στην εσωτερική αναζήτηση."
Δεύτερο hack: πώς να μην χάσετε κρίσιμα πράγματα σε ένα σωρό συνομιλίες
«Αν εργάζεστε σε μια κατανεμημένη ομάδα, τότε πιθανότατα ένα σημαντικό μέρος της ημέρας σας περνάει στο Slack - και σε αυτήν την περίπτωση έχετε συνηθίσει να κάνετε κάτι σαν αυτό: «@myteam, βοήθησε/κοίτα/μπήκε το σωστό... ”.” Αλλά υπάρχει ένα πρόβλημα με την αφθονία των πληροφοριών - και μια ξεχωριστή αναφορά μπορεί να χαθεί μεταξύ άλλων μηνυμάτων.
Στο Skyeng μας βοηθά ένα bot μέσω του οποίου μπορείτε να γράψετε ένα μήνυμα και να προσθέσετε ετικέτα σε οποιοδήποτε αριθμό ατόμων ή ομάδων. Το χρησιμοποιούμε σε περιπτώσεις όπου είναι πολύ σημαντικό οι άνθρωποι να διαβάζουν ή να αντιδρούν: θα χτυπάει ατελείωτα μέχρι να πατήσετε το κουμπί "Διάβασα" - δεν θα μπορείτε να το παραλείψετε ή να το αγνοήσετε."
Ερώτηση προς απάντηση: τι να κάνετε με την τεκμηρίωση;
«Πολλές γνώσεις προέρχονται από τεχνικούς, αλλά δεν ξέρουν όλοι πώς να τις περιγράψουν καλά.
Εξάλλου, δεν έχετε κανένα μεταγλωττιστή ή linter που να σας λέει αν το κάνετε σωστά ή όχι - και συχνά η έξοδος που έχουμε είναι ακατανόητη, κακώς μορφοποιημένη και ημιτελές κείμενο. Φυσικά, πρέπει να το κάνετε κανονικά, όχι επειδή ήρθε κάποιος και είπε "είναι απαραίτητο" - το κάνετε καλά για τον εαυτό σας: σε ένα ή δύο μήνες θα το διαβάσετε και θα καταλάβετε. Και ένα άλλο άτομο, ανοίγοντας ένα έγγραφο, δεν θα το κλείσει αμέσως για πάντα, συνειδητοποιώντας ότι είναι άχρηστο.
Μέρος του podcast αφιερωμένο στην ερώτηση "Πόσα άτομα χρειάζονται για να γραφτεί μια καλή τεκμηρίωση ή να γίνει μια κανονική επίδειξη"
Αλλά το ερώτημα παραμένει: πόσος χρόνος να διατεθεί για αυτό και πώς να το κάνουμε αποτελεσματικά;
Και αν υπάρχει μια ειλικρινής απάντηση εδώ: εάν δεν εμπλέκονται επιχειρηματίες και εάν δεν βιώσουν εμπειρικά τον αντίκτυπο της καλής τεκμηρίωσης, υπάρχει κίνδυνος η προσπάθεια να αποφέρει μικρή απόδοση. Αυτή είναι περισσότερο μια ιστορία για την αλλαγή του πολιτισμού.
Για τα υπόλοιπα, η εμπειρία και η καθοδήγηση θα σας σώσουν. Ανάλογα προγραμματισμού ζευγών, παρακολούθησης προόδου και αναθεωρήσεων κώδικα μπορεί να είναι κατάλληλα εδώ - δείχνοντας βέλτιστες πρακτικές, λάθη και βαρετό στο τέλος."
Μπόνους: «Εντάξει, θα τους το πω έτσι, θα καταλάβουν»
Το ερώτημα "πόσο χρόνο να αφιερώσετε σε αυτό και σε ποιο επίπεδο να το κάνετε" είναι σημαντικό όχι μόνο στο πλαίσιο της τεκμηρίωσης, αλλά γενικά για τη μεταφορά οποιασδήποτε γνώσης. Η επίδειξη είναι επίσης ένα εξαιρετικό παράδειγμα κοινής χρήσης πληροφοριών. Αλλά υπάρχουν αποχρώσεις: για παράδειγμα, πώς να βεβαιωθείτε ότι καταλαμβάνουν ελάχιστο χρόνο.
Κανάλι ανταλλαγής γνώσεων μεταξύ ανάπτυξης: εσωτερικές αναφορές, χρήσιμα βιβλία, άρθρα κ.λπ. Το δομημένο εκχύλισμα αποθηκεύεται επίσης στο Notion.
Εν μέρει, αυτά τα προβλήματα μπορούν να επιλυθούν με την πρακτική των εσωτερικών αναφορών. Μία φορά την εβδομάδα, λαμβάνονται 40-60 λεπτά σε λιγότερο απασχολημένο χρόνο - και τα παιδιά κάνουν μια αναφορά βίντεο για συναδέλφους από διαφορετικά έργα. Ομάδα Frontend του βασικού προϊόντος - Vimbox - σχετικά με το κιτ διεπαφής χρήστη, το οποίο μπορεί να έχει θέμα για οποιοδήποτε άλλο έργο. Η ομάδα ανάπτυξης μάρκετινγκ μίλησε για μια βιβλιοθήκη για τον εντοπισμό και την καταγραφή αιτημάτων, η οποία προσέλκυσε αμέσως το ενδιαφέρον πολλών άλλων έργων. Η ομάδα του έργου Mathematics μοιράστηκε την εμπειρία της από τη μετάβαση από το REST API στο GraphQL. Η ομάδα ομαδικών μαθημάτων σκέφτεται να μοιραστεί πώς ήταν οι πρώτοι που άλλαξαν στην PHP 7.4. Και ούτω καθεξής.
Η λίστα διατηρείται από τον Μάιο του 2018 και έχει πάνω από 120 συμμετοχές
Όλες οι συσκέψεις ξεκινούν μέσω του εταιρικού Google Meet, καταγράφονται και εμφανίζονται εντός 1.5 ωρών σε έναν φάκελο σε μια κοινόχρηστη μονάδα δίσκου Google και οι σύνδεσμοι προς τις ηχογραφήσεις αντιγράφονται στο ίδιο Slack. Δηλαδή, δεν χρειάζεται να έρθετε σε περίπτωση έκτακτης ανάγκης, αλλά παρακολουθήστε το αργότερα με ταχύτητα 20 - συνήθως η ίδια η αναφορά διαρκεί έως και XNUMX λεπτά και η συζήτηση - πώς γίνεται. Αλλά δεν ξεπερνάμε την ώρα)
PS Τι λειτούργησε και τι δεν λειτούργησε για εσάς;
Χρήσιμοι σύνδεσμοι:
- Ο Rodion Nagornov από το Kaspersky Lab περίπου και γιατί αυτό δεν είναι τεκμηρίωση (ευχαριστώ το κανάλι του Igor για τη σύνδεση , υπάρχουν πολλά άλλα τέτοια).
- Ο Igor Tsupko από το Flan σχετικά με αυτό στην παρέα μου
- Alexey Kataev από το Skyeng (κενά γνώσης σε τεχνολογίες και συγκεκριμένους τομείς) σε μια κατανεμημένη ομάδα.
- Sergey Goncharuk από το Flant σχετικά με τη μετάδοση πληροφοριών - , εάν αντιμετωπίσετε πρόβλημα σε μια κατανεμημένη ομάδα.
Πηγή: www.habr.com