Τα πέντε λάθη που κάνουν οι εταιρείες όσον αφορά την τεχνική τεκμηρίωση
Έχω δει ξανά και ξανά. Μία από τις πιο κοινές αδυναμίες που έχω δει σε εταιρείες μηχανικών-πράγματι, μια σχεδόν καθολική βλάβης-είναι η έλλειψη κατάλληλης τεχνικής τεκμηρίωσης. Ορισμένοι θα γελάσει αυτό μακριά ως λεπτομέρεια? ωστόσο, οι επιπτώσεις είναι συχνά σοβαρές. Ολόκληρο το μέλλον μιας εταιρείας μπορεί να γίνει ή να χαθεί με βάση το ποσό της προσοχή που δίνουν σε αυτό το issue.Over τα χρόνια, έχω εντοπίσει πέντε προβλήματα που έχω διαπιστώνεται ότι είναι ιδιαίτερα κοινό όταν πρόκειται για την σύνταξη τεχνικού φακέλου. Θα ήθελα να μοιραστώ αυτές τις σκέψεις μαζί σας, με την ελπίδα να εμποδίζουν τους άλλους να πέσουν κάτω την ίδια paths.1. Δεν έχουν οποιοδήποτε χρήστη manualsDon't γέλιο. Αυτό μπορεί να φαίνεται σαν ένα αρκετά βασικό λάθος-παράλογο, ακόμη-αλλά είναι εκπληκτικά κοινό. Έχω που αντιμετωπίζουν πολλές επιχειρήσεις που δεν παρέχουν εγχειρίδια χρήσης για τα προϊόντα τους, ή εγχειριδίων των οποίων σκελετική λεπτό ή ετών από την ημερομηνία αυτή. Στην πραγματικότητα, είχα εκτιμούν ότι περίπου οι μισές από τις μικρές εταιρείες μηχανικών που έχω αντιμετώπισε εμπίπτουν στην κατηγορία αυτή. (Φυσικά, συναντά κανείς σπάνια αυτό το πρόβλημα κατά την αγορά off-the-shelf λογισμικού ή ηλεκτρονικά είδη ευρείας κατανάλωσης. Μεταξύ των μηχανικών όμως, είναι μια απογοητευτικά γνωστή ιστορία.) Θυμάμαι πώς ένας μηχανικός μου είπε γιατί η εταιρεία του δεν παρείχε εγχειρίδια χρήστη με τα προϊόντα τους. Μέσα αποσιωπούνται ήχους, είπε, "Είναι γιατί δεν κάνει τα χρήματα με το γράψιμο εγχειριδίων. Δεν είναι τα χρήματα λήψης επιχειρηματικών συμμετοχών, έτσι διαχείριση μας δεν θέλει να σπαταλήσει το χρόνο σε αυτό." Μια ενοχλημένος έκφραση παρεισφρήσει του πρόσωπο, τότε έσκυψε πιο κοντά και είπε: "Έχουμε χάσει έτσι πολλούς πελάτες, διότι δεν έχουμε αξιοπρεπή τεκμηρίωσης. Συζητήστε για να δεκάρα-σοφός, λίρα-ανόητο!" Δεν είναι μόνο οι πελάτες που υποφέρουν όταν εγχειρίδια είναι ανεπαρκείς ή δεν υφίστανται. Τι γίνεται με τους ίδιους τους εργαζομένους; Τι συμβαίνει όταν ένα νέο μηχανικός έρχεται επί του πλοίου, και πρέπει να μάθει γρήγορα; Ή τι θα συμβεί όταν η υπάρχουσα μηχανικοί ανάγκη να εξοικειωθούν περισσότερο τον εαυτό τους με άγνωστες πτυχές της σειράς προϊόντων τους; Η τεκμηρίωση χρήστη, αν σωστά γραπτή, μπορεί να προσφέρει ένα απαλό και αποτελεσματικό τρόπο για την μέχρι ταχύτητα. Δεν είναι, θα αναγκαστούν να στηριχθεί βαρύτερα σε άλλους μηχανικούς να τους εκπαιδεύσει, χάνοντας έτσι το χρόνο όλων των εμπλεκομένων. Εβδομάδες, αν δεν μήνα, από πολύτιμες ανθρώπινου δυναμικού μπορούν να χαθούν σε αυτό fashion.2. Δεν έχουν κατάλληλα εσωτερικά documentationIt του δεν είναι μόνο η τεκμηρίωση χρήστη ότι οι εταιρείες που υπολείπονται για. Εσωτερικά έγγραφα είναι συχνά ένα ατύχημα, καθώς, όπως οι εταιρείες σκαρφάλωμα να κυκλοφορήσει ένα προϊόν. Στη βιασύνη τους να διαθέσουν τα προϊόντα στην αγορά, οι εταιρείες συχνά ας εσωτερικά έγγραφα σχεδιασμού τους πτώση απελπιστικά από την wayside.It δεν βοηθά ότι προγραμματιστές και οι μηχανικοί είναι γνωστά για τις lackluster δεξιότητες επικοινωνίας, και η τεκμηρίωση είναι μια εργασία που που σπάνια απολαμβάνουν. Έχω συνάντησε πολλές εταιρείες λογισμικού, για παράδειγμα, το λογισμικό των οποίων τα σχέδια είχαν ένα δυσεπίλυτο χάος λόγω της έλλειψης των αρχιτεκτονικών εγγράφων, διεπαφή περιγραφές και παρατηρήσεις κώδικα. Δυστυχώς, έχω δει παρόμοια προβλήματα όταν πρόκειται για μηχανικά σχέδια, ηλεκτρονικά σχέδια, διαδικασίες παραγωγής; ονομάζετε ve it.I 'μιλήσει με τους μηχανικούς οι εταιρείες των οποίων έχουν πάει είτε στο πλαίσιο, ή έχουν ταλαντεύονται σχετικά με το χείλος του γκρεμού. Σχεδόν πάντα, η έλλειψη επαρκούς τεκμηρίωσης έχει αποτελέσει σημαντικό παράγοντα στην εν λόγω situations.I πάντα να αφεντικά και τους συναδέλφους μου, "Θέλω να βεβαιωθείτε ότι η δουλειά μου είναι darned καλά τεκμηριωμένη. If I η εταιρεία δεν θα υπονομεύεται από κάθε ατόμου absence.Unfortunately, πολλοί εργαζόμενοι λαμβάνουν το αντίθετο καρφί. Οι σκοπίμως τσιγγουνεύω για την τεκμηρίωση, πιστεύοντας ότι αυτό θα τους εξασφαλίσει κάποια εργασιακή ασφάλεια-και μερικές φορές, αυτό λειτουργεί. Ωστόσο, ένας έξυπνος εργοδότης γνωρίζει ότι ένας μηχανικός που τα έγγραφα και αξίζει πολύ περισσότερο από ό, τι άλλο μηχανικό που κρατάει τα χαρτιά του κοντά στο γιλέκο του. Το τελευταίο μπορεί να είναι απαραίτητη σε σύντομο χρονικό διάστημα, αλλά σε τελική ανάλυση, αυτός είναι μια μακροπρόθεσμη liability.3. AudienceThis Λήθης ένα πρόβλημα που εμφανίζεται συχνά κατά την ανάπτυξη τεκμηρίωση χρήστη. Προγραμματιστές και μηχανικούς συχνά ξεχνάμε ότι εγχειρίδια τους θα πρέπει να διαβάζονται από ανθρώπους που είναι εξοικειωμένοι με τα προϊόντα τους, ή που δεν έχουν τις ίδιες τεχνικές δεξιότητες. Θυμάμαι μία εταιρεία κυρίως-μια εταιρεία ελεγκτή μηχανή στη δυτική ακτή. "Χρήστης τους εγχειρίδιο" ήταν horrible Hodge-podge ακρωνυμίων, απροσδιόριστους όρους και φαινομενικά τυχαίες σκέψεις, με περίπου ένα διαδικασίες που αναφέρονται στην δωδεκάδα δεν συγκεκριμένη σειρά. Τεκμηρίωση χρήστη υπήρχαν τέτοιες βασικές λεπτομέρειες όπως το πώς να ξεκινήσετε την ελεγκτής επάνω, ή πώς να το σταματήσει σε περίπτωση έκτακτης ανάγκης-κρίσιμες λεπτομέρειες νεοφώτιστος ότι κάθε χρήστης θα πρέπει να περιμένουν να βρουν σε ένα manual.A σχετικό πρόβλημα είναι η αδυναμία χρήσης σωστή γλώσσα. Ας εξετάσουμε την περίπτωση κατά την οποία πολλοί από τους αναγνώστες δεν είναι μητρική Αγγλικά ομιλητές-δηλαδή, κατά την εμπορία ενός προϊόντος στην Ευρώπη ή την Ασία, ή όταν γράφετε διαδικασίες για τη συναρμολόγηση των αλλοδαπών εργαζομένων στο εργοστάσιο. Σε τέτοιες περιπτώσεις, μπορεί να είναι αναγκαίο να διατηρηθεί η προσέγγιση μπορεί να είναι χρήσιμη για τη λήψη περίπλοκο κείμενο λίγο πιο εύκολο να absorb.4. Δεν είναι κατάλληλα graphicIt είναι αναμφισβήτητα clichÃÆ'Ã,  ©, αλλά αλήθεια, ωστόσο, έχει μια εικόνα ισούται με χίλιες λέξεις. Ομοίως, εγχειρίδιο που κάνει συνετή χρήση των εικόνων και διαγραμμάτων, θα είναι πολύ πιο εύκολο να καταλάβουμε από ένα που αποτελείται εξ ολοκλήρου από descriptions.Some κείμενο ότι αυτό είναι περιττό και παιδικά. Δεν θα ήθελα, και μου εμπειρία έχει δείξει ότι η πλειοψηφία των χρηστών εκτιμούν την ύπαρξη αυτών των οπτικών οδηγών. Θυμηθείτε? Δεν έχει σημασία πόσο εξελιγμένα αναγνώστες σας, είναι ακόμα ανθρώπου. Ακόμα και μια έξυπνη, αλλιώς προσεκτικός αναγνώστης μπορεί να κατά λάθος παραλείψετε κάποια σημαντική λεπτομέρεια, ειδικά όταν πιέζεται για time.5. Δεν αγωνίζονται για excellenceIt ενδιαφέρον να δούμε πώς προγραμματιστές και μηχανικούς να καταβληθούν προσπάθειες για την αριστεία σε πολλές πτυχές του έργου τους, ακόμα λαμβάνει το ακριβώς αντίθετο, όταν πρόκειται για την τεκμηρίωση. "Ποιος νοιάζεται για διατύπωση ούτως ή άλλως;" Έχω ακούσει πολλά μηχανικοί πω. "Δεν είμαστε γράφει ποίηση ή σενάρια εδώ. Εκείνο που έχει σημασία είναι ότι τεκμηρίωση πρέπει να είναι τεχνικώς ακριβή. "Αυτό είναι ένα συγκλονιστικά κοντόφθαλμη θεώρηση. ακρίβεια Τεχνικά είναι πράγματι σημαντικό, αλλά έτσι είναι παρουσίαση και στυλ. Λίγοι μηχανικοί θα ακούσετε έναν αιτούντα εργασία που εμφανίζεται σε ένα μπουρνούζι και παντόφλες, ή έναν δικηγόρο της ασκήσεως της προσφυγής που μιλάει σαν κορίτσι κοιλάδα-ακόμη και με κάποιο τρόπο, αυτά τα ίδια μηχανικοί περιμένουν τους συναδέλφους τους Προγραμματιστές (ή, ακόμη χειρότερα, ένας πελάτης!) να slog μέσα από τις σελίδες του meandering, κακή διατύπωση του κειμένου. Ακόμη και τα θεμελιώδη ζητήματα όπως η ορθογραφία, γραμματική και διόρθωση αντιμετωπίζονται συχνά ως απλή ενόχληση-ασήμαντος λεπτομέρειες που δεν αξίζουν περισσότερο από μια βιαστική ματιά. (Για την ανακούφιση μου, δεν έχω αντιμετωπίσει τέτοιες συμπεριφορές στο χώρο της εργασίας μου. Σπεύδω να πω, μήπως κάποιος νομίζω ότι είμαι διαμαρτύρονται για τους ανθρώπους που δουλεύω με! Οχι, έχω διαπιστώσει ότι όλοι αναγνωρίζουν την αξία της αριστείας, για την οποία είμαι πάντα ευγνώμων. But I digress.) Θυμηθείτε: Κατά τη σύνταξη για τους συναδέλφους Προγραμματιστές κάποιου, θα πρέπει να έχουμε κατά νου ότι πρέπει να απορροφήσουν συχνά ογκώδη ποσά των πληροφοριών σε ελάχιστα ποσά του χρόνου. Όταν γραφής για το ευρύ κοινό, πρέπει κανείς να κάνει το κείμενο ως ευγενής και εύκολο να χωνέψει το δυνατόν περισσότερο, καθώς φοβούνται ότι θα γίνουν χάνονται σε έναν ωκεανό geekspeak. Είτε έτσι είτε αλλιώς, θέτοντας μια μικρή επιπλέον προσπάθεια σε θέματα της κομψότητας και στιλ μπορεί κάνουν έναν κόσμο difference.I δεν θα υπεισέλθω σε λεπτομέρειες σχετικά με το τι αποτελεί καλή τεχνική γραφής, όπως αυτό θα ήταν πέρα από το πεδίο εφαρμογής του κειμένου αυτού. Αρκεί να πω ότι ένας καλός προγραμματιστής ή μηχανικός θα πρέπει να βεβαιωθείτε ότι γραφή του είναι ευανάγνωστο και καλά οργανωμένες, και ότι οι ροές ομαλά από το ένα θέμα στο another.I θα ήταν ενθουσιασμένος απίστευτο και αν ποτέ δεν είδα ένα άλλο εγχειρίδιο πρόχειρο, ή αν ποτέ δεν άκουσα μια άλλη ιστορία για την εταιρείες καταρρέουν λόγω της μη-ανύπαρκτη τεκμηρίωση. Μια απελπιστική φαντασία; Μπορεί. Ακόμα, ελπίζω ότι κάποια techies έξω εκεί θα διαβάσετε αυτό το μήνυμα, και ότι θα πάρει να heart.About Η AuthorV. Berba Velasco έχει διδακτορικό δίπλωμα Ηλεκτρολόγου Μηχανικού και έχει πλόες εμπόριο του για σχεδόν μια δεκαετία. Στο διάστημα αυτό, έχει ανακαλύψει επανειλημμένα τη σημασία της καλής τεχνικής γραφής, καθώς και τις παγίδες που μπορεί να προκύψει από αγνοώντας value.Dr του. Velasco εργάζεται σήμερα ως ανώτερος ηλεκτρικού και μηχανικός λογισμικού για Κυτταρικής Technology Limited (http://www.immunospot.com, http://www.elispot-analyzers.de), μια εταιρεία βιοτεχνολογίας στο Κλίβελαντ,
Αρθρο Πηγη: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
Webmaster παίρνει τον κώδικα HTML
Προσθεστε αυτο το αρθρο στον ιστοτοπο σας τωρα!
Webmaster υποβάλλει τα άρθρα σας
Εγγραφή που απαιτείται καμία! Συμπληρώστε τη μορφή και το άρθρο σας είναι στον κατάλογο Messaggiamo.Com
