Γεια σε όλους!
Ονομάζομαι Masha, εργάζομαι ως μηχανικός διασφάλισης ποιότητας στον όμιλο εταιρειών Tinkoff. Η εργασία QA περιλαμβάνει πολλή επικοινωνία με διαφορετικούς ανθρώπους από διαφορετικές ομάδες, και ήμουν επίσης διευθυντής και λέκτορας εκπαιδευτικών προγραμμάτων, οπότε ο χάρτης επικοινωνίας μου ήταν όσο το δυνατόν ευρύτερος. Και κάποια στιγμή έσκασα: συνειδητοποίησα ότι δεν μπορώ πια, δεν μπορώ, δεν μπορώ να συμπληρώσω κολασμένους τόνους αδιάβαστους πίνακες και έγγραφα.
Σίγουρα ο καθένας από εσάς φαντάστηκε τώρα τι λέω και ξέσπασε κρύος ιδρώτας: λίστες με επώνυμα χωρίς αλφαβητική σειρά, πίνακες με εκατοντάδες στήλες με ατημέλητη διάταξη, πίνακες με χιλιάδες γραμμές στις οποίες πρέπει να σβήσετε το δάχτυλό σας στον τροχό του ποντικιού για να κοιτάξετε την κατεύθυνση, τόνοι σελίδων με αμέτρητες οδηγίες, εκατοντάδες επιστολές που αποστέλλονται μεταξύ τους με δεδομένα που πρέπει να αναλυθούν και να συστηματοποιηθούν και να τοποθετηθούν στους ίδιους μη αναγνώσιμους πίνακες.
Κι έτσι, όταν ξεψύχησα λίγο, αποφάσισα να γράψω αυτό το άρθρο. Θα μιλήσω για το πώς μπορείτε κανονικά (ακόμη και μερικές φορές βολικά) να διατηρείτε μια ποικιλία εγγράφων εκτός προϊόντος. Ελπίζω ότι το άρθρο θα διασκορπιστεί στο δίκτυο και το επίπεδο της κόλασης στα τμήματα που γειτνιάζουν με την ανάπτυξη θα πέσει τουλάχιστον λίγο και οι άνθρωποι (συμπεριλαμβανομένου εμένα) θα γίνουν λίγο πιο χαρούμενοι.
Εργαλεία
Η τεκμηρίωση του προϊόντος συχνά φυλάσσεται μαζί με κώδικα, κάτι που είναι καλό. Και η τεκμηρίωση εκτός προϊόντος συνήθως αποθηκεύεται οπουδήποτε. Συχνά οι άνθρωποι προσπαθούν να φέρουν πληροφορίες από διαφορετικά μέρη στο Confluence, και εμείς δεν αποτελούμε εξαίρεση. Οπότε η υπόλοιπη ιστορία είναι γι' αυτόν.
Γενικά, το Confluence είναι μια προηγμένη μηχανή wiki. Σας επιτρέπει να εργάζεστε με δεδομένα σε διαφορετικούς τύπους εμφάνισης: κείμενο με μορφοποίηση, πίνακες, διάφορα γραφήματα. Αυτό είναι ένα πολύ ενδιαφέρον και ισχυρό εργαλείο, αλλά αν δεν ξέρετε πώς να το μαγειρέψετε, τότε θα λάβετε άλλη μια συλλογή μη αναγνώσιμων εγγράφων. Θα σας μάθω να μαγειρεύετε!
μακροεντολές
Σχεδόν όλη η μαγεία του Confluence βασίζεται στις μακροεντολές. Υπάρχουν πολλές μακροεντολές και μπορούν να συνδυαστούν μεταξύ τους. Είναι επί πληρωμή και δωρεάν, επιπλέον θα υπάρχουν διάφορα παραδείγματα μακροεντολών με συνδέσμους προς τεκμηρίωση για αυτά.
Η διεπαφή για την εργασία με μακροεντολές είναι όσο το δυνατόν πιο απλή. Για να προσθέσετε μια μακροεντολή, πρέπει να κάνετε κλικ στο συν και να επιλέξετε το επιθυμητό στοιχείο από τη λίστα.
Αν η μακροεντολή είναι αυτάρκης, δηλαδή δεν απαιτεί την εισαγωγή κάποιου άλλου μέσα της, μοιάζει με μπλοκ.
Εάν μια μακροεντολή χρειάζεται κάτι μέσα της για να λειτουργήσει, μοιάζει με κουτί.
Ταυτόχρονα, μπορείτε να βάλετε όσα άλλα θέλετε μέσα σε ένα πλαίσιο, αρκεί να υπάρχει λογική στην πυραμίδα σας.
Κάθε μακροεντολή έχει μια προεπισκόπηση: δείχνει αμέσως εάν έχετε συμπληρώσει και ρυθμίσει σωστά τη μακροεντολή.
πρότυπα
Εκτός από τις μακροεντολές, υπάρχει ένα βολικό εργαλείο για την προπλήρωση περιεχομένου - αυτό είναι ένα πρότυπο.
Τα πρότυπα μπορούν να χρησιμοποιηθούν κατά τη δημιουργία οποιασδήποτε σελίδας: απλώς κάντε κλικ στις τρεις τελείες δίπλα στο κουμπί "Δημιουργία" και επιλέξτε το επιθυμητό πρότυπο.
Στη συνέχεια, όλο το περιεχόμενο που υπάρχει στο πρότυπο θα προστεθεί στη σελίδα που δημιουργήθηκε.
Οποιοσδήποτε μπορεί να δημιουργήσει σελίδες από πρότυπα, αλλά μόνο όσοι έχουν τα δικαιώματα να δημιουργούν ή να επεξεργάζονται οι ίδιοι πρότυπα μπορούν να δημιουργήσουν σελίδες. Μπορείτε να προσθέσετε επιπλέον οδηγίες στο πρότυπο σχετικά με τον τρόπο συντήρησης της σελίδας.
Επιτραπέζια Μαγεία
Στην πραγματικότητα, ως τεχνικός, μου αρέσουν πολύ τα τραπέζια και μπορώ να τυλίξω σχεδόν οποιαδήποτε πληροφορία σε αυτά (αν και αυτό δεν είναι πάντα αποτελεσματικό). Οι ίδιοι οι πίνακες είναι σαφείς, δομημένοι, επεκτάσιμοι, μαγικοί!
Αλλά ακόμα και μια υπέροχη οντότητα όπως ένα τραπέζι μπορεί να χαλάσει. Και μπορεί να χρησιμοποιηθεί με επιτυχία και ακόμη και να βελτιωθεί. Περισσότερα για αυτό παρακάτω.
Φιλτράρισμα (προσθήκη επί πληρωμή)
Οποιοσδήποτε τεράστιος μη αναγνώσιμος πίνακας μπορεί να γίνει λίγο λιγότερο τεράστιος και λίγο πιο ευανάγνωστος χρησιμοποιώντας το φιλτράρισμα. Για να το κάνετε αυτό, μπορείτε να χρησιμοποιήσετε μια μακροεντολή επί πληρωμή
Μέσα σε αυτήν τη μακροεντολή, πρέπει να βάλετε ένα τραπέζι (ακόμα και το πιο άσχημο είναι δυνατό, το κύριο πράγμα είναι να το σπρώξετε εντελώς). Στη μακροεντολή, μπορείτε να επιλέξετε στήλες για αναπτυσσόμενο φίλτρο, φίλτρο κειμένου, αριθμητικό και φίλτρο ημερομηνίας.
Απλά φανταστείτε ότι όλες οι πληροφορίες για τους υποψηφίους για όλες τις κενές θέσεις καταγράφονται σε πίνακα πίνακα. Φυσικά, χωρίς ταξινόμηση - οι άνθρωποι δεν έρχονται στις συνεντεύξεις με αλφαβητική σειρά. Και πρέπει να καταλάβετε εάν έχετε πάρει συνέντευξη από έναν συγκεκριμένο υποψήφιο στο παρελθόν. Απλά πρέπει να βάλετε αυτήν την κόλαση σε μια μακροεντολή φίλτρου, να προσθέσετε ένα φίλτρο κειμένου με το επώνυμο - και voila, οι πληροφορίες βρίσκονται στην οθόνη σας.
Αξίζει να σημειωθεί ότι το φιλτράρισμα τεράστιων πινάκων μπορεί να επηρεάσει την απόδοση του συστήματος και τον χρόνο φόρτωσης της σελίδας, επομένως η τοποθέτηση ενός τεράστιου πίνακα στο φίλτρο είναι μια προσωρινή δοκιμασία, είναι καλύτερο να δημιουργηθεί μια διαδικασία στην οποία οι άνθρωποι δεν χρειάζεται να δημιουργούν τεράστιους μη αναγνώσιμους πίνακες (ένα παράδειγμα της διαδικασίας θα είναι στο τέλος του άρθρου).
Ταξινόμηση (προσθήκη επί πληρωμή)
Με Magic Macro
Για παράδειγμα, έχετε τον ίδιο πίνακα με τους αιτούντες και πρέπει να υπολογίσετε πόσες συνεντεύξεις πραγματοποιήθηκαν σε έναν συγκεκριμένο μήνα - ταξινομήστε κατά ημερομηνία και χαρείτε.
Συγκεντρωτικοί πίνακες (προσθήκη επί πληρωμή)
Ας περάσουμε τώρα σε μια πιο ενδιαφέρουσα περίπτωση. Φανταστείτε ότι το τραπέζι σας είναι τεράστιο και πρέπει να υπολογίσετε κάτι σε αυτό. Φυσικά, μπορείτε να το αντιγράψετε στο Excel, να υπολογίσετε τι χρειάζεστε και να ανεβάσετε τα δεδομένα πίσω στο Confluence. Μπορείτε να εφαρμόσετε μια μακροεντολή μία φορά;
Για παράδειγμα: έχετε έναν πίνακα που περιέχει τα δεδομένα όλων των υπαλλήλων - πού βρίσκονται γεωγραφικά και ποιες θέσεις κατέχουν. Για να υπολογίσετε πόσα άτομα βρίσκονται σε κάθε πόλη, πρέπει να επιλέξετε στη μακροεντολή "Συγκεντρωτικός πίνακας" τη σειρά με την οποία συγκεντρώνονται τα δεδομένα (τοποθεσία) και τον τύπο λειτουργίας (προσθήκη).
Φυσικά, μπορείτε να ομαδοποιήσετε σύμφωνα με πολλά κριτήρια ταυτόχρονα, μπορείτε να δείτε όλες τις δυνατότητες
Γραφήματα (προσθήκη επί πληρωμή)
Όπως είπα, δεν αγαπούν όλοι τα τραπέζια όσο εγώ. Δυστυχώς, οι περισσότεροι μάνατζερ δεν τους αρέσουν καθόλου. Αλλά όλοι αγαπούν τα φωτεινά χρώματα.
Οι δημιουργοί του Confluence σίγουρα το γνώριζαν αυτό (σίγουρα έχουν και αφεντικά που αγαπούν τις αναφορές και τα charts, πού θα ήταν χωρίς αυτό). Επομένως, μπορείτε να χρησιμοποιήσετε τη μαγική μακροεντολή
Φυσικά, αυτή η μακροεντολή έχει και ρυθμίσεις. Ένας σύνδεσμος προς την τεκμηρίωση για οποιαδήποτε μακροεντολή μπορεί να βρεθεί στη λειτουργία επεξεργασίας αυτής της μακροεντολής.
Ευκολία συνάθροισης
Οι πληροφορίες από τις προηγούμενες παραγράφους μάλλον δεν ήταν αποκάλυψη για εσάς. Αλλά τώρα σίγουρα ξέρετε πώς να χρησιμοποιείτε μακροεντολές και μπορώ να προχωρήσω στο πιο ενδιαφέρον μέρος του άρθρου.
ετικέτες
Είναι κακό όταν οι άνθρωποι αποθηκεύουν πληροφορίες σε ένα μη δομημένο άρθρο ή σε έναν τεράστιο πίνακα. Ακόμη χειρότερο είναι όταν τμήματα αυτών των πληροφοριών δεν είναι μόνο δυσανάγνωστα, αλλά και διάσπαρτα στις εκτάσεις του Confluence. Ευτυχώς, είναι δυνατή η συλλογή διάσπαρτων πληροφοριών σε ένα μέρος. Για αυτό πρέπει να χρησιμοποιήσετε
Οποιοσδήποτε αριθμός ετικετών μπορεί να προστεθεί σε οποιαδήποτε σελίδα. Κάνοντας κλικ σε μια ετικέτα θα μεταφερθείτε σε μια σελίδα συγκέντρωσης με συνδέσμους προς όλο το περιεχόμενο με αυτήν την ετικέτα, καθώς και ένα σύνολο σχετικών ετικετών. Σχετικές ετικέτες είναι αυτές που εμφανίζονται συχνά στην ίδια σελίδα.
Ιδιότητες σελίδας
Μπορείτε να προσθέσετε μια άλλη ενδιαφέρουσα μακροεντολή στη σελίδα για πληροφορίες δομής -
Δώστε προσοχή στο αναγνωριστικό - είναι βολικό να το ρυθμίσετε ώστε να αναρτά διαφορετικές ομάδες ιδιοτήτων σε διαφορετικές σελίδες (ή ακόμα και διαφορετικές ομάδες ιδιοτήτων σε μία σελίδα).
αναφορές
Ανά ετικέτες, μπορείτε να συλλέγετε αναφορές. Για παράδειγμα, μακροεντολή
Αλλά μια πιο ενδιαφέρουσα αναφορά είναι μια μακροεντολή
Προκύπτει ένας συνοπτικός πίνακας πληροφοριών από διαφορετικές πηγές. Είναι ωραίο που έχει βολικά χαρακτηριστικά: προσαρμοστική διάταξη, ταξινόμηση ανά στήλη. Επίσης, ένας τέτοιος πίνακας αναφορών μπορεί να διαμορφωθεί μέσα στη μακροεντολή.
Κατά τη διαμόρφωση, μπορείτε να αφαιρέσετε ορισμένες στήλες από την αναφορά, να ορίσετε την προεπιλεγμένη κατάσταση ή τον αριθμό των εμφανιζόμενων εγγραφών. Μπορείτε επίσης να ορίσετε το αναγνωριστικό ιδιότητας σελίδας για να βλέπετε μόνο τις πληροφορίες που χρειάζεστε.
Για παράδειγμα, έχετε πολλές σελίδες υπαλλήλων, αυτές οι σελίδες έχουν ένα σύνολο ιδιοτήτων σχετικά με ένα άτομο: σε ποιο επίπεδο βρίσκεται, πού βρίσκεται, πότε μπήκε στην ομάδα και ούτω καθεξής. Αυτές οι ιδιότητες επισημαίνονται id = υπάλληλος_inf. Και υπάρχει ένα δεύτερο σύνολο ιδιοτήτων στην ίδια σελίδα, το οποίο περιέχει πληροφορίες για ένα άτομο ως μέλος μιας ομάδας: τι ρόλο εκτελεί το άτομο, σε ποια ομάδα ανήκει και ούτω καθεξής. Αυτές οι ιδιότητες επισημαίνονται ID = team_inf. Στη συνέχεια, κατά τη σύνταξη μιας αναφοράς, μπορείτε να εμφανίσετε μόνο πληροφορίες για ένα ή δύο ταυτότητες ταυτόχρονα - όποιο είναι πιο βολικό.
Η ομορφιά αυτής της προσέγγισης είναι ότι ο καθένας μπορεί να συλλέξει τον πίνακα πληροφοριών που χρειάζεται, ο οποίος δεν θα αντιγράψει τίποτα και θα ενημερωθεί όταν ενημερωθεί η κύρια σελίδα. Για παράδειγμα: ένας αρχηγός ομάδας δεν νοιάζεται πότε οι προγραμματιστές του έπιασαν δουλειά, αλλά είναι σημαντικό τι ρόλο παίζει ο καθένας τους στην ομάδα. Ο αρχηγός της ομάδας θα συλλέξει μια αναφορά για την ομάδα. Και ο λογιστής δεν νοιάζεται ποιος εκτελεί ποιο ρόλο, αλλά οι θέσεις είναι σημαντικές - θα συγκεντρώσει μια αναφορά για τις θέσεις. Σε αυτήν την περίπτωση, η πηγή πληροφοριών δεν θα αντιγραφεί ούτε θα μεταφερθεί.
Τελική διαδικασία
Εντολή
Έτσι, μπορούμε να δομήσουμε όμορφα και να συγκεντρώσουμε αποτελεσματικά πληροφορίες στο Confluence χρησιμοποιώντας μακροεντολές ως παράδειγμα. Αλλά στην ιδανική περίπτωση, πρέπει να βεβαιωθείτε ότι οι νέες πληροφορίες δομούνται αμέσως και εντάσσονται σε όλους τους μηχανισμούς συγκέντρωσης που χρησιμοποιούνται ήδη.
Εδώ μια δέσμη μακροεντολών και προτύπων θα έρθουν στη διάσωση. Για να κάνετε τους χρήστες να δημιουργήσουν νέες σελίδες στη σωστή μορφή, μπορείτε να χρησιμοποιήσετε τη μακροεντολή Δημιουργία από πρότυπο. Προσθέτει ένα κουμπί στη σελίδα, κάνοντας κλικ στο οποίο δημιουργείται μια νέα σελίδα από το πρότυπο που χρειάζεστε. Με αυτόν τον τρόπο αναγκάζετε τους ανθρώπους να εργαστούν αμέσως στη μορφή που χρειάζεστε.
Στο πρότυπο από το οποίο μπορείτε να δημιουργήσετε μια σελίδα, πρέπει να προσθέσετε ετικέτες, τη μακροεντολή "Ιδιότητες σελίδας" και έναν πίνακα με τις ιδιότητες που χρειάζεστε εκ των προτέρων. Συνιστώ επίσης να προσθέσετε οδηγίες σχετικά με τις τιμές με τις οποίες πρέπει να γεμίσετε τη σελίδα και τις τιμές ιδιοτήτων.
Τότε η τελική διαδικασία θα μοιάζει με αυτό:
- Δημιουργείτε ένα πρότυπο για έναν συγκεκριμένο τύπο πληροφοριών.
- Σε αυτό το πρότυπο, προσθέστε ετικέτες και ιδιότητες σελίδας σε μια μακροεντολή.
- Σε οποιοδήποτε βολικό μέρος, δημιουργήστε μια ριζική σελίδα με ένα κουμπί, κάνοντας κλικ στο οποίο δημιουργείται μια θυγατρική σελίδα από το πρότυπο.
- Ξεκινήστε από τη βασική σελίδα των χρηστών που ενδεχομένως θα δημιουργήσουν τις απαραίτητες πληροφορίες (σύμφωνα με το επιθυμητό πρότυπο, κάνοντας κλικ στο κουμπί).
- Συλλέξτε μια αναφορά για τις ιδιότητες της σελίδας μέσω των ετικετών που καθορίσατε στο πρότυπο.
- Χαρείτε: έχετε όλες τις πληροφορίες που χρειάζεστε σε μια βολική μορφή.
Παγίδες
Ως μηχανικός ποιότητας, μπορώ να πω με ασφάλεια ότι δεν υπάρχει τίποτα τέλειο στον κόσμο. Ακόμα και τα θεϊκά τραπέζια είναι ατελείς. Και υπάρχουν παγίδες στην παραπάνω διαδικασία.
- Εάν αποφασίσετε να αλλάξετε τα ονόματα ή τη σύνθεση των ιδιοτήτων της σελίδας, θα πρέπει να ενημερώσετε όλα τα ήδη δημιουργημένα αντικείμενα, ώστε τα δεδομένα τους να ενταχθούν σωστά στη συνοπτική αναφορά. Αυτό είναι λυπηρό, αλλά από την άλλη, σας αναγκάζει να σκεφτείτε λεπτομερώς την «αρχιτεκτονική» του συνόλου πληροφοριών σας, κάτι που είναι ένα πολύ ενδιαφέρον έργο.
- Θα πρέπει να γράψετε έναν αξιοπρεπή αριθμό οδηγιών για το πώς να συμπληρώνετε τους πίνακες πληροφοριών και να χρησιμοποιείτε τις ετικέτες. Αλλά, από την άλλη πλευρά, μπορείτε απλά να πετάξετε αυτό το άρθρο σε όλους τους σωστούς ανθρώπους.
Ένα παράδειγμα αποθήκευσης τεκμηρίωσης εκτός προϊόντος
Μέσω της διαδικασίας που περιγράφεται παραπάνω, μπορείτε να οργανώσετε την αποθήκευση σχεδόν οποιασδήποτε πληροφορίας. Η ομορφιά της προσέγγισης είναι ότι είναι καθολική: μόλις οι χρήστες τη συνηθίσουν, σταματούν να κάνουν χάος. Επίσης ένα μεγάλο (αλλά όχι δωρεάν) πλεονέκτημα είναι η δυνατότητα να συλλέγετε διάφορα στατιστικά στοιχεία εν κινήσει και να σχεδιάζετε όμορφα διαγράμματα.
Θα δώσω ένα παράδειγμα της διαδικασίας διατήρησης πληροφοριών για την ομάδα.
Για κάθε άτομο στην ομάδα, αποφασίσαμε να δημιουργήσουμε μια κάρτα υπαλλήλου. Αντίστοιχα, έχουμε ένα πρότυπο σύμφωνα με το οποίο κάθε νέο άτομο δημιουργεί αυτή την κάρτα για τον εαυτό του και διατηρεί όλα τα προσωπικά του στοιχεία σε αυτήν.
Όπως μπορείτε να δείτε, έχουμε έναν αναλυτικό πίνακα ακινήτων και αμέσως έχουμε οδηγίες για το πώς να διατηρήσετε αυτή τη σελίδα. Μερικές από τις ετικέτες τοποθετούνται από τους ίδιους τους εργαζόμενους σύμφωνα με τις οδηγίες, στο πρότυπο μόνο οι κύριες: η ετικέτα κάρτας υπάλληλος-κάρτα, ετικέτα κατεύθυνσης κατεύθυνση-συμπεριλαμβάνω και ετικέτα εντολής ομάδα-qa.
Ως αποτέλεσμα, αφού ο καθένας έχει δημιουργήσει μια κάρτα για τον εαυτό του, λαμβάνεται ένας πλήρης πίνακας με πληροφορίες για τους υπαλλήλους. Αυτές οι πληροφορίες μπορούν να χρησιμοποιηθούν σε διαφορετικά σημεία. Οι διαχειριστές πόρων μπορούν να συλλέγουν γενικούς πίνακες για τον εαυτό τους και οι επικεφαλής ομάδων μπορούν να συλλέγουν πίνακες εντολών προσθέτοντας μια ετικέτα ομάδας στην επιλογή.
Ανά ετικέτες, μπορείτε να δείτε διαφορετικές περιλήψεις, για παράδειγμα, κατά qa-αναβάθμιση-σχέδιο θα εμφανιστούν όλες οι εργασίες για την ανάπτυξη QA. Ταυτόχρονα, κάθε άτομο στην κάρτα υπαλλήλου του διατηρεί μια σημαντική ιστορία και το δικό του σχέδιο ανάπτυξης - δημιουργεί μια ένθετη σελίδα από το πρότυπο σχεδίων ανάπτυξης.
Συμπέρασμα
Κρατήστε οποιαδήποτε τεκμηρίωση με τέτοιο τρόπο ώστε να μην ντρέπεστε γι' αυτό και να μην πληγώνονται οι χρήστες βασανιστικά!
Ελπίζω πραγματικά ότι το άρθρο θα είναι χρήσιμο και θα έρθει η τάξη σε όλη την τεκμηρίωση του κόσμου.
Πηγή: www.habr.com