शीर्ष पांच गलतियों कि कंपनियों के तकनीकी दस्तावेज के संबंध में करना
मैं इसे बार बार देखा है. सबसे आम कमजोरी है कि मैं इंजीनियरिंग कंपनियों में देखा है में से एक, वास्तव में, एक लगभग सार्वभौमिक गलती-उचित तकनीकी दस्तावेज का अभाव है. कुछ इस एक के रूप में हँसेगा लघु विस्तार, हालांकि, नतीजों अक्सर गंभीर हैं. एक कंपनी के पूरे भविष्य या बनाया जा सकता है खो ध्यान वे इस issue.Over साल, मैं पांच समस्या है कि मुझे पहचान लिया है के लिए भुगतान की गई राशि पर आधारित पाया विशेष रूप से आम को जब यह तकनीकी दस्तावेज में लिखने की बात आती है. मैं तुम्हारे साथ इन विचारों का हिस्सा ही paths.1 नीचे गिरने से दूसरों को रोकने की आशा में, चाहें. नहीं किसी भी उपयोगकर्ता रही manualsDon't हँसो. यह एक बहुत ही बुनियादी ग़लती की तरह दिखते हैं बेतुका सकता है, लेकिन यह भी हैरत की बात आम है. कर रहे हैं मैं कई कंपनियों है कि उपयोगकर्ता के मैनुअल अपने उत्पादों, या जिनके पुस्तिकाओं के लिए नहीं प्रदान कर सामना करना पड़ा है skeletally साल या पतली बाहर की तारीख का. वास्तव में, मैं अनुमान था कि इस वर्ग के बारे में छोटे इंजीनियरिंग कंपनियों है कि मैं गिर का सामना करना पड़ा है आधा. (बेशक, एक शायद ही कभी इस समस्या का सामना करना पड़ता है जब खरीदने बंद-the-शेल्फ सॉफ्टवेयर या उपभोक्ता इलेक्ट्रॉनिक्स. इंजीनियरों के बीच हालांकि, यह एक depressingly परिचित कहानी है.) मुझे याद है कैसे एक इंजीनियर ने मुझे बताया क्यों उनकी कंपनी अपने उत्पादों के साथ किसी भी उपयोगकर्ता के मैनुअल प्रावधान नहीं था. में hushed टन, उन्होंने कहा, "यह क्योंकि हम किसी भी पैसे मैनुअल लिखने से नहीं करते है. यह एक पैसा नहीं है उपक्रम बना रही है, तो हमारे प्रबंधन के लिए इस पर समय बर्बाद नहीं करना चाहता." एक नाराज अभिव्यक्ति में crept अपने चेहरा है, तो वह करीब निर्भर हो, और कहा, "हम कई ग्राहकों को खो दिया है क्योंकि हम सभ्य प्रलेखन नहीं है. बारे में बात करो मूर्ख!" पैसा जा रहा है, बुद्धिमान पौंड यह सिर्फ ग्राहकों को जो कष्ट नहीं है जब मैनुअल अपर्याप्त या गैर हैं बराबर है. के बारे में क्या स्वयं कर्मचारियों? क्या होता है जब एक नए इंजीनियर बोर्ड पर आता है, और जल्दी से सीख गया है? या क्या होता है जब मौजूदा इंजीनियरों को परिचित की जरूरत खुद को और अपने उत्पाद लाइनों की अपरिचित पहलुओं के साथ? उपयोगकर्ता दस्तावेज़, अगर ठीक से लिखा है, ऊपर लाने के लिए तेज गति की भद्र और कारगर तरीका प्रदान कर सकते हैं. इसके बिना, उन्हें भरोसा करने को मजबूर हो जाएगा अधिक अन्य इंजीनियरों पर भारी उन्हें शिक्षित करने के लिए इस प्रकार का संबंध सब के समय बर्बाद कर रहे. सप्ताह, मूल्यवान जनशक्ति की नहीं तो महीनों में, यह fashion.2 में squandered जा सकता है. नहीं होने उचित आंतरिक है documentationIt न केवल उपयोगकर्ता प्रलेखन कि कंपनियों पर कम होना. आंतरिक प्रलेखन अक्सर एक के रूप में अच्छी तरह से मारा जाता है, के रूप में कंपनियों को एक उत्पाद जारी संघर्ष. जल्दबाजी में उनके उत्पादों के लिए बाजार में लाने के लिए, कंपनियों अक्सर जाने उनकी आंतरिक डिजाइन दस्तावेजों wayside.It द्वारा बुरी तरह गिर मदद नहीं, कि प्रोग्रामर और इंजीनियर lackluster संचार कौशल रखने के लिए कुख्यात रहे है और प्रलेखन एक काम यह है कि वे शायद ही कभी मजा आता है. मैं कई सॉफ्टवेयर कंपनियों का सामना करना पड़ा है, उदाहरण के लिए, जिसका डिजाइन सॉफ्टवेयर एक असभ्य वास्तु दस्तावेजों, इंटरफ़ेस और विवरण की कमी के कारण गंदगी थे के लिए कोड टिप्पणी में. अफसोस की बात है, मैं ऐसी ही समस्याओं को देखा है यह यांत्रिक डिजाइन जब आता है, इलेक्ट्रॉनिक डिजाइन, विनिर्माण प्रक्रियाओं? आप 'it.I इंजीनियरों जिसका कंपनियों के या तो नीचे चला गया है, से बात की ve नाम या teetering गया है कगार पर. लगभग हमेशा, पर्याप्त दस्तावेजीकरण के अभाव में ऐसे situations.I में एक प्रमुख कारक हमेशा मेरे बॉस और साथियों ने बताया गया है, "मुझे विश्वास है कि मेरे काम को अच्छी तरह से प्रलेखित है रफ़ू करना चाहता हूँ. अगर मैं कम्पनी, छुट्टी या यदि मैं एक कार दुर्घटना में मरने के लिए मुझे पूरा यकीन है कि इस कंपनी पर मेरे बिना मार्च कर सकते हैं बनाना चाहता हूँ. "यह पूरी तरह प्रलेखन रखने को सुनिश्चित करने के पीछे मुख्य कारणों में से एक होना चाहिए कि कंपनी से नहीं अपंग हो जाएगा किसी भी इंसान है absence.Unfortunately, कई कर्मचारियों के विपरीत हमले लो. वे जानबूझकर प्रलेखन पर कम देना, यह सोच कर कि यह उन्हें कुछ काम की सुरक्षा सुनिश्चित करना होगा और कभी कभी, यह काम करता है. हालांकि, एक स्मार्ट नियोक्ता को पता है कि एक इंजीनियर जो दस्तावेज अच्छी तरह से अभी तक एक और इंजीनियर जो अपने कार्ड रहती है उसकी बनियान के पास से भी अधिक मूल्य की है. बाद अल्पावधि में आवश्यक हो सकता है, लेकिन अंततः, वह एक लंबी liability.3 शब्द है. भूल है एक audienceThis समस्या अक्सर तब होता है जब उपयोगकर्ता दस्तावेज़ विकासशील. प्रोग्रामर और इंजीनियर अक्सर भूल जाते हैं कि उनके मैनुअल को पढ़ने के होने जा रहे हैं के लोग हैं, जो अपने उत्पादों, या जो एक ही तकनीकी कौशल की जरूरत नहीं है के साथ अपरिचित हैं. मैं विशेष रूप से एक कंपनी के पश्चिमी तट पर एक मशीन नियंत्रक कंपनी याद है. अपने उपयोगकर्ता "मैन्युअल" एक था भयानक कमेरा-podge के acronyms, अपरिभाषित नियम और प्रतीत होता है बेतरतीब विचारों के बारे में एक दर्जन से कोई विशेष क्रम में सूचीबद्ध प्रक्रियाओं के साथ. अपने उपयोगकर्ता प्रलेखन जैसे बुनियादी जानकारी के अभाव कैसे शुरू करने के लिए ऊपर नियंत्रक, या किसी आपातकालीन स्थिति के मामले में कैसे रोक को महत्वपूर्ण जानकारी है कि कोई नौसिखिया उपयोगकर्ता के लिए एक manual.A संबंधित समस्या में पाने की उम्मीद करनी चाहिए उचित भाषा का प्रयोग नाकाम रही है. जिसमें इस मामले पर गौर पाठकों के कई अंग्रेजी बोलने वालों-देशी नहीं कर रहे हैं कहते हैं, जब यूरोप या एशिया में एक उत्पाद विपणन या जब विदेशी मूल के कारखाने के श्रमिकों के लिए विधानसभा प्रक्रिया लेखन. ऐसे मामलों में, यह रखना आवश्यक हो सकता है भाषा काफी आसान है. यदि यह संभव नहीं है, कहते हैं जब परिसर विवरण पर चर्चा है कि मांग सटीक के एक महान सौदे के एक बार कुछ जिसे उपयुक्त चुना चार्ट, चित्र या चित्रों को जोड़कर भरपाई कर सकते हैं. कोई एक दृष्टिकोण जटिल पाठ बनाने में मददगार थोड़ा absorb.4 के लिए आसान हो सकता है. नहीं उपयुक्त graphicIt जा रहा है इसमें शक नहीं clichÃÆ'Ã, एक ©, लेकिन सच है फिर भी एक तस्वीर है एक हजार शब्दों के रंग. इसी तरह, एक मैन्युअल कि चित्रों और चित्र बहुत हो समझने में आसान हो जाएगा से एक है कि पाठ descriptions.Some की पूरी तरह से बनी इस विचार को बचकाना और अनावश्यक है के विवेकपूर्ण उपयोग करता है. मैं नहीं, और मेरे अनुभव दिखा दिया है कि उपयोगकर्ताओं के बहुमत इन दृश्य गाइड होने की सराहना करते हैं. याद रखें, कोई फर्क नहीं पड़ता कैसे अपने पाठकों को परिष्कृत कर रहे हैं, वे अभी भी मानव हैं. यहां तक कि एक समझदार, नहीं तो सावधान पाठक कर सकते हैं गलती से कुछ महत्वपूर्ण विस्तार से याद आती है, खासकर जब time.5 के लिए लगाए. नहीं है excellenceIt देखना कैसे प्रोग्रामर और इंजीनियरों को उत्कृष्टता के लिए अपने काम है, अभी तक के कई पहलुओं में प्रयास कर सकते हैं दिलचस्प के लिए प्रयास सटीक विपरीत दृष्टिकोण रखना यह दस्तावेज में जब आ जाता है. "कौन शब्दों के बारे में वैसे भी परवाह करता है?" मैंने सुना है बहुत से इंजीनियर कहते हैं. "हम कविता या पटकथाओं यहाँ नहीं लिख रहे हैं. क्या मायने रखता है कि प्रलेखन तकनीकी रूप से सही. होना चाहिए "यह एक appallingly अदूरदर्शी देखें. तकनीकी सटीकता वास्तव में महत्वपूर्ण है, लेकिन इतना प्रस्तुति और शैली के हैं. कुछ इंजीनियरों को नौकरी आवेदक ध्यान से सुनते हैं जो एक bathrobe और चप्पल, या मुकदमेबाजी वकील, जो एक घाटी लड़की की तरह बोलता है और अभी तक, किसी भी तरह ये वही इंजीनियरों की अपेक्षा उनके साथी तकनीकविद् (या बुरा, एक ग्राहक! में पता चलता है) को meandering के पन्नों के माध्यम से आगे बढ़ना, खराब phrased पाठ. यहां तक कि वर्तनी, व्याकरण और proofreading जैसे बुनियादी मामलों अक्सर मात्र annoyances के रूप में इलाज किया हैं विवरण लायक कुछ भी नहीं है कि एक सरसरी निगाह से भी अधिक कर रहे हैं. क्षुद्र (मेरी राहत के लिए है, मैं नहीं रोजगार के मेरे घर पर कोई भी इस तरह के नजरिए का सामना करना पड़ा. मैं यह कहना जल्दी, किसी को ऐसा न हो कि लगता है कि मैं कि मैं लोगों के साथ काम करने के बारे में शिकायत कर रहा हूँ! नहीं, मैंने पाया है कि हम सभी को उत्कृष्टता के मूल्य की सराहना करते हैं, जिसके लिए मैं हमेशा आभारी हूँ. लेकिन याद रखना मैं विषयान्तर.): जब एक साथी तकनीकी विशेषज्ञ के लिए लेखन, एक भालू चाहिए मन में है कि वे अक्सर समय की अल्प मात्रा में सूचना का मोटा मात्रा में अवशोषित चाहिए. कब laymen के लिए लेखन, एक के रूप में पाठ करना चाहिए कोमल और संभव के रूप में पचाने में आसान है, ऐसा न हो कि वे geekspeak के सागर में खो जाते हैं. किसी भी तरह से, सुंदरता और शैली के मामले में थोड़ा अतिरिक्त प्रयास डाल सकते हैं बना difference.I की दुनिया क्या अच्छा लेखन तकनीक का गठन किया है कि इस पाठ के दायरे से बाहर हो जाएगा के बारे में विस्तार में नहीं जाऊँगा. कहने के लिए पर्याप्त है कि एक अच्छा प्रोग्रामर या इंजीनियर सुनिश्चित करना चाहिए कि उनके लेखन और अच्छी तरह से पठनीय है आयोजित किया, और यह कि यह एक विषय से another.I को सुचारू रूप से प्रवाह विश्वास से परे रोमांचित किया जाएगा अगर मैं एक और असावधानीपूर्ण मैनुअल, या यदि मैंने सुना एक और कहानी के बारे में कभी नहीं कभी नहीं देखा अस्तित्व प्रलेखन के कारण टूट कंपनियों. एक निराशाजनक कल्पना? हो सकता है. फिर भी, मैं आशा करता हूँ कि कुछ तकनीकी विशेषज्ञ वहाँ इस संदेश पढ़ा जाएगा, और यह कि वे इसे AuthorV heart.About ले जाऊँगा. Berba Velasco इलेक्ट्रिकल इंजीनियरिंग में डॉक्टरेट की है और लगभग एक दशक के लिए अपने व्यापार को चलाने गया है. उस समय के दौरान उन्होंने बार बार अच्छा तकनीकी लेखन के महत्व का पता चला है, और उस से नुकसान हो सकता है इसके value.Dr की अनदेखी. Velasco वर्तमान के रूप में काम करता है एक वरिष्ठ बिजली और सेलुलर प्रौद्योगिकी लिमिटेड (http://www.immunospot.com, के लिए सॉफ्टवेयर इंजीनियर http://www.elispot-analyzers.de), क्लीवलैंड में एक जैव प्रौद्योगिकी कंपनी,
Article Source: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
Webmaster Get Html Code
Add this article to your website now!
Webmaster Submit your Articles
No registration required! Fill in the form and your article is in the Messaggiamo.Com Directory!
