नया ऊर्जा क्षेत्र: तकनीकी दस्तावेज़ीकरण सर्वोत्तम प्रथाएँ

लेख

15 दिसंबर 2001

बैटरी और ऊर्जा भंडारण में, सबसे आम दस्तावेज़ीकरण विफलता गलत अनुवाद नहीं है। यह भाषाई संस्करण हैं जो अलग होते जा रहे हैं क्योंकि उत्पाद श्रृंखला उनके आगे बढ़ती जा रही है।

प्रति उत्पाद श्रृंखला एक आधिकारिक विशिष्टता

बैटरी और भंडारण उत्पाद तेजी से पुनरावृत्त होते हैं और उत्पाद शृंखला तेजी से विस्तारित होती है, और सबसे आम विफलता मोड गलत अनुवाद नहीं है बल्कि भाषा संस्करण अलग हो रहे हैं। चीनी विनिर्देश तीन संशोधनों से गुजर चुका है और जर्मन अभी भी पहले स्थान पर है; गलत फ़ाइल का उपयोग करने वाला ग्राहक मामूली बात है, इससे इंस्टॉलेशन त्रुटि एक घटना है।

समाधान यह है कि प्रति उत्पाद पंक्ति में एक आधिकारिक विनिर्देश रखा जाए और उससे प्रत्येक भाषा संस्करण प्राप्त किया जाए। कोई भी परिवर्तन पहले स्रोत पर किया जाता है और फिर बाहर कर दिया जाता है। यह स्वयं-स्पष्ट लगता है, फिर भी अधिकांश टीमों की फ़ाइलें दर्जनों दस्तावेज़ों और ईमेल में बिखरी हुई हैं, और यह बताने का कोई तरीका नहीं है कि कौन सा आधिकारिक है।

एकल स्रोत स्थिरता को हल करने से कहीं अधिक करता है: यह स्थानीयकरण मूल्य निर्धारण को अनुमानित बनाता है। जब स्रोत स्थिर होता है, तो अनुवाद कार्यभार का अनुमान लगाया जा सकता है। जब स्रोत प्रतिदिन बदलता है, तो कोई भी उद्धरण काल्पनिक होता है।

दस्तावेज़ संस्करण को उत्पाद संस्करण से बाइंड करें

दस्तावेज़ की पहली पंक्ति में यह बताया जाना चाहिए कि यह किस हार्डवेयर और फ़र्मवेयर संस्करण से मेल खाता है। नए ऊर्जा उत्पाद अक्सर संशोधित होते हैं, और यहां तक ​​​​कि एक ही मॉडल में बैचों के बीच पैरामीटर अंतर हो सकता है। ग्राहकों द्वारा पुराने मैनुअल के साथ नई यूनिट फिट कराना विवाद का एक आम कारण है।

बाइंडिंग का अर्थ है कि दस्तावेज़ संख्या में उत्पाद संस्करण संख्या होती है, परिवर्तन चरण दर चरण संस्करण को प्रभावित करते हैं, और एक नियम है जिसके लिए उत्पाद संस्करण में परिवर्तन होने पर दस्तावेज़ों की पुन: समीक्षा और पुन: अनुवाद किया जाना चाहिए। यह नियम परियोजना की शुरुआत में ही तय किया जाना चाहिए, प्रत्येक घटना के बाद दोबारा बातचीत नहीं की जानी चाहिए।

कार्यान्वयन की कठिनाई आमतौर पर संगठनात्मक होती है - उत्पाद बदलने वाली टीम और दस्तावेज़ों का प्रबंधन करने वाली टीम अक्सर एक ही लोग नहीं होते हैं। दस्तावेज़ समीक्षा को स्वचालित रूप से ट्रिगर करने के लिए उत्पाद परिवर्तन के लिए कुछ तंत्र की आवश्यकता होती है; इसे मैन्युअल रूप से देखना ठीक नहीं है।

सुरक्षा दस्तावेज़ीकरण प्रथम श्रेणी वितरणयोग्य है

बैटरी उत्पाद अधिकांश उपभोक्ता वस्तुओं की तुलना में अधिक सुरक्षा जोखिम रखते हैं: थर्मल रनवे, ओवरचार्ज, परिवहन आवश्यकताएं और स्थापना नियम। उनमें से कोई भी गलत तरीके से लिखा गया व्यक्ति व्यक्तिगत चोट की घटना का कारण बन सकता है। इसलिए सुरक्षा अध्यायों, चेतावनी अनुवादों और अनुपालन विवरणों को अन्य सामग्री के समान नहीं माना जाना चाहिए; वे प्रथम श्रेणी के डिलिवरेबल्स हैं, अलग से शेड्यूल किए गए, समीक्षा किए गए और संग्रहीत किए गए हैं।

वास्तविक परियोजनाओं पर यह अनुभाग नियमित रूप से संपीड़ित होता है, क्योंकि सुरक्षा अध्याय छोटे होते हैं और सरल दिखते हैं। उनकी समीक्षा आवश्यकताएँ वास्तव में उच्चतम हैं - अनुवाद न केवल सही होना चाहिए बल्कि लक्ष्य बाजार के नियामक शब्दों से मेल खाना चाहिए। चेतावनी बयानों में कई न्यायालयों में निर्दिष्ट फॉर्मूलेशन होते हैं, और शब्दों में एक छोटा सा बदलाव कानूनी अर्थ बदल देता है।

सुरक्षा दस्तावेज़ीकरण के लिए एक अलग चेकलिस्ट बनाएं: प्रत्येक भाषा, प्रत्येक नियामक आवश्यकता, प्रत्येक संस्करण, एक-एक करके टिक करें। किसी घटना में वह चेकलिस्ट आपका सबसे मजबूत सबूत होती है.

प्रति-भाषा समीक्षा: इस परत को न छोड़ें

नई ऊर्जा लॉन्च में आमतौर पर अच्छी संख्या में भाषाएं शामिल होती हैं, इसलिए समीक्षा का दबाव सामान्य उत्पाद की तुलना में अधिक होता है। डोमेन और लक्ष्य भाषा को समझने वाले समीक्षक उन समस्याओं को पकड़ लेते हैं जो सामान्य अनुवादक और स्वचालित जांच से छूट जाते हैं - उदाहरण के लिए स्थानीय मानक में निर्दिष्ट प्रतिपादन वाला एक शब्द, एक इकाई प्रारूप जो स्थानीय सम्मेलन से मेल नहीं खाता है, या एक वाक्य जिसका शाब्दिक अनुवाद इसके अर्थ को उलट देता है।

जब समीक्षा क्षमता कम हो, तो सुरक्षा दस्तावेज़ीकरण और मुख्य-बाज़ार की भाषाओं को प्राथमिकता दें, और बाकी को जोखिम-आधारित स्तर के साथ संभालें। समीक्षा को पूरी तरह से ख़त्म करना कोई विकल्प नहीं है: बिना किसी मानवीय जाँच के मशीनी अनुवाद अंततः विनियमित सामग्री पर विफल हो जाएगा।

FangService के पास नई ऊर्जा तकनीकी दस्तावेज़ीकरण के लिए संबंधित भाषाओं में डोमेन समीक्षा संसाधन हैं, सुरक्षा और अनुपालन फ़ाइलें प्रथम श्रेणी-डिलीवर करने योग्य प्रक्रिया के माध्यम से चलती हैं। उत्पाद प्रकार और लक्षित बाज़ार लाएँ, और एक दस्तावेज़ के लिए वर्गीकरण योजना के साथ शुरुआत करें।

भंडारण दस्तावेज़ीकरण का सबसे कठिन हिस्सा: डेटा का एक सेट, कई पाठक

भंडारण परियोजनाओं में असामान्य संख्या में पक्ष शामिल होते हैं - मालिक, ईपीसी ठेकेदार, ग्रिड कंपनी, संचालन टीम, अग्नि समीक्षक। वे एक ही प्रणाली को पूरी तरह से अलग प्राथमिकताओं के साथ देखते हैं। ग्रिड कंपनी ग्रिड कनेक्शन पैरामीटर और सुरक्षा सेटिंग्स पढ़ती है; संचालन दोष कोड और प्रतिस्थापन प्रक्रियाओं को पढ़ता है; मालिक परिचालन लागत और वारंटी सीमाएं पढ़ता है। एक व्यापक तकनीकी मैनुअल के रूप में लिखा गया दस्तावेज़ उनमें से किसी का भी उपयोग नहीं करता है; केवल परिचालन के लिए लिखा गया है, ग्रिड कंपनी इसे स्वीकार नहीं करेगी। इसका तरीका लेयरिंग है: पैरामीटर टेबल मास्टर दस्तावेज़ बनाते हैं, प्रत्येक भूमिका को अपना त्वरित गाइड मिलता है, नंबरिंग सुसंगत होती है, और संशोधन पर पूरी श्रृंखला एक साथ अपडेट होती है।

रिवीजन सिंक्रोनाइजेशन दूसरा जाल है। एक बीएमएस फ़र्मवेयर अपग्रेड जो गलती कोड जोड़ता और हटाता है, यदि केवल मास्टर मैनुअल में बदला जाता है, तो पुराने संस्करण पर भूमिका-विशिष्ट गाइड छोड़ देता है, और फ़ील्ड पुराने कोड तालिका के विरुद्ध नए फ़र्मवेयर की तलाश में समाप्त हो जाती है। FangService इन परियोजनाओं के लिए शब्दावलियों और संस्करण संख्याओं को बांधता है, प्रत्येक व्युत्पन्न दस्तावेज़ को संशोधन के दायरे में शामिल करता है, और प्रमुख संशोधनों के लिए एक परिवर्तन सारांश पृष्ठ जारी करता है ताकि ग्राहक की संचालन टीम सीधे प्रशिक्षण सामग्री को अपडेट कर सके।

तकनीकी दस्तावेज़ीकरण का आकलन वर्ष-तीन की लागत तय करता है

ऊर्जा-भंडारण दस्तावेज़ीकरण में एक परिभाषित विशेषता है: कई पार्टियों और कई संस्करणों के साथ विकास, वितरण और संचालन तक फैला एक लंबा जीवनचक्र। जो परियोजनाएँ दस्तावेज़ीकरण को एकमुश्त वितरण योग्य मानती हैं, उन्हें तीसरे वर्ष में इसे बार-बार लिखना पड़ता है - संचालन एक नया प्रारूप चाहता है, ग्राहक एक नया टेम्पलेट चाहता है, एक नया बाज़ार एक नई भाषा चाहता है, और हर बार सामग्री पुरानी फ़ाइलों से निकाली जाती है।

परिसंपत्ति निर्धारण का अर्थ है पहले ड्राफ्ट से पुन: उपयोग के लिए डिज़ाइन करना: सुसंगत संरचना, स्वतंत्र मॉड्यूल, स्थिर नंबरिंग, नियंत्रित शब्दावली, ट्रेस करने योग्य संस्करण। एक बार वे अपनी जगह पर आ जाएं, तो भाषा जोड़ना गुणन है और भूमिका जोड़ना पुनर्लेखन के बजाय संयोजन है। प्रत्येक बाद के पुन: उपयोग पर सामने की सफाई में बिताया गया समय वापस आ जाता है।

FangService डिलीवर करने और चले जाने के बजाय प्रोजेक्ट के हिस्से के रूप में टर्म बेस, ट्रांसलेशन मेमोरी और वर्जनिंग नियम प्रदान करता है। ग्राहक को जो मिलता है वह न केवल अनुवाद है बल्कि एक परिसंपत्ति है जो काम करती रहती है, जो एक छोटी टीम के लिए अक्सर यूनिट-मूल्य छूट से अधिक मूल्यवान होती है।