নতুন শক্তি সেক্টর: প্রযুক্তিগত ডকুমেন্টেশন সেরা অনুশীলন

প্রবন্ধ

15 ডিসেম্বর, 2001

ব্যাটারি এবং শক্তি সঞ্চয়স্থানে, সবচেয়ে সাধারণ ডকুমেন্টেশন ব্যর্থতা একটি ভুল অনুবাদ নয়। এটি ভাষার সংস্করণগুলি আলাদা হয়ে যাচ্ছে কারণ পণ্যের লাইন তাদের থেকে এগিয়ে চলে।

প্রোডাক্ট লাইন প্রতি একটি প্রামাণিক স্পেসিফিকেশন

ব্যাটারি এবং স্টোরেজ পণ্যগুলি দ্রুত পুনরাবৃত্তি করে এবং পণ্যের লাইনগুলি দ্রুত প্রসারিত হয় এবং সবচেয়ে সাধারণ ব্যর্থতার মোডটি একটি ভুল অনুবাদ নয় তবে ভাষা সংস্করণগুলি আলাদা হয়ে যায়। চীনা স্পেসিফিকেশন তিনটি সংশোধনের মাধ্যমে হয়েছে এবং জার্মান এখনও প্রথমটিতে রয়েছে; একটি গ্রাহক ভুল ফাইল ব্যবহার করে ছোট, এটি থেকে একটি ইনস্টলেশন ত্রুটি একটি ঘটনা।

ফিক্স হল প্রতি পণ্য লাইনে একটি প্রামাণিক স্পেসিফিকেশন রাখা এবং এটি থেকে প্রতিটি ভাষার সংস্করণ বের করা। যে কোনো পরিবর্তন প্রথমে উৎসে করা হয় এবং তারপর পুশ করা হয়। এটি স্বতঃসিদ্ধ শোনাচ্ছে, তবুও বেশিরভাগ দলের ফাইলগুলি কয়েক ডজন নথি এবং ইমেল জুড়ে ছড়িয়ে ছিটিয়ে রয়েছে এবং কোনটি প্রামাণিক তা বলার কোন উপায় নেই৷

একক উত্স সামঞ্জস্য সমাধানের চেয়ে আরও বেশি কিছু করে: এটি স্থানীয়করণের মূল্যকে অনুমানযোগ্য করে তোলে। উৎস স্থিতিশীল হলে, অনুবাদ কাজের চাপ অনুমানযোগ্য। যখন উৎস প্রতিদিন পরিবর্তিত হয়, কোন উদ্ধৃতি কাল্পনিক।

পণ্য সংস্করণে নথি সংস্করণ আবদ্ধ করুন

একটি নথির প্রথম লাইনটি কোন হার্ডওয়্যার এবং ফার্মওয়্যার সংস্করণের সাথে সামঞ্জস্যপূর্ণ তা উল্লেখ করা উচিত। নতুন শক্তি পণ্যগুলি প্রায়শই সংশোধন করা হয়, এমনকি একই মডেল ব্যাচগুলির মধ্যে পরামিতি পার্থক্য বহন করতে পারে। একটি পুরানো ম্যানুয়াল সঙ্গে একটি নতুন ইউনিট ফিট গ্রাহকদের বিরোধ একটি সাধারণ উৎস.

বাইন্ডিং মানে দস্তাবেজ নম্বরটি পণ্য সংস্করণ নম্বর বহন করে, ধাপে ধাপে সংস্করণটিকে পরিবর্তন করে, এবং এমন একটি নিয়ম রয়েছে যার জন্য একটি পণ্য সংস্করণ পরিবর্তিত হলে দস্তাবেজগুলিকে পুনরায় পর্যালোচনা এবং পুনরায় অনুবাদ করতে হবে। এই নিয়মটি প্রকল্পের শুরুতে সেট করা উচিত, প্রতিটি ঘটনার পরে পুনরায় আলোচনা করা নয়।

বাস্তবায়নের অসুবিধা সাধারণত সাংগঠনিক হয় — পণ্য পরিবর্তনকারী দল এবং দল পরিচালনাকারী দলিল প্রায়শই একই ব্যক্তি নয়। স্বয়ংক্রিয়ভাবে নথি পর্যালোচনা ট্রিগার করার জন্য একটি পণ্য পরিবর্তনের জন্য কিছু প্রক্রিয়া প্রয়োজন; ম্যানুয়ালি এটির জন্য পর্যবেক্ষণ করা হয় না।

নিরাপত্তা ডকুমেন্টেশন একটি প্রথম শ্রেণীর বিতরণযোগ্য

ব্যাটারি পণ্যগুলি বেশিরভাগ ভোগ্যপণ্যের তুলনায় উচ্চ নিরাপত্তা ঝুঁকি বহন করে: তাপীয় পলাতক, অতিরিক্ত চার্জ, পরিবহন প্রয়োজনীয়তা এবং ইনস্টলেশন নিয়ম। ভুলভাবে লেখা যে কোনো একটি ব্যক্তিগত আঘাতের ঘটনা ঘটাতে পারে। তাই নিরাপত্তা অধ্যায়, সতর্কতা অনুবাদ এবং সম্মতি বিবৃতি অন্যান্য বিষয়বস্তু হিসাবে একই ভিত্তিতে বিবেচনা করা উচিত নয়; এগুলি প্রথম-শ্রেণীর সরবরাহযোগ্য, নির্ধারিত, পর্যালোচনা করা এবং আলাদাভাবে সংরক্ষণাগারভুক্ত।

বাস্তব প্রকল্পগুলিতে এই বিভাগটি নিয়মিতভাবে সংকুচিত হয়, কারণ নিরাপত্তা অধ্যায়গুলি ছোট এবং দেখতে সহজ। তাদের পর্যালোচনার প্রয়োজনীয়তা প্রকৃতপক্ষে সর্বোচ্চ - অনুবাদটি অবশ্যই সঠিক হতে হবে না তবে লক্ষ্য বাজারের নিয়ন্ত্রক শব্দের সাথে মেলে। সতর্কীকরণ বিবৃতিতে বেশ কয়েকটি এখতিয়ারে মনোনীত ফর্মুলেশন রয়েছে এবং শব্দের একটি ছোট পরিবর্তন আইনি অর্থ পরিবর্তন করে।

নিরাপত্তা ডকুমেন্টেশনের জন্য একটি পৃথক চেকলিস্ট তৈরি করুন: প্রতিটি ভাষা, প্রতিটি নিয়ন্ত্রক প্রয়োজনীয়তা, প্রতিটি সংস্করণ, একে একে টিক দেওয়া। একটি ঘটনায়, সেই চেকলিস্টটি আপনার সবচেয়ে শক্তিশালী প্রমাণ।

প্রতি-ভাষা পর্যালোচনা: এই স্তরটি এড়িয়ে যাবেন না

নতুন এনার্জি লঞ্চে সাধারণত অনেকগুলি ভাষা জড়িত থাকে, তাই একটি সাধারণ পণ্যের তুলনায় পর্যালোচনার চাপ বেশি। সমালোচকরা যারা ডোমেন এবং টার্গেট ভাষা বোঝেন তারা সমস্যাগুলি ধরতে পারেন যা সাধারণ অনুবাদক এবং স্বয়ংক্রিয় চেকগুলি মিস করে — উদাহরণস্বরূপ একটি স্থানীয় স্ট্যান্ডার্ডে একটি নির্দিষ্ট রেন্ডারিং সহ একটি শব্দ, একটি ইউনিট বিন্যাস যা স্থানীয় নিয়মের সাথে মেলে না, বা একটি বাক্য যার আক্ষরিক অনুবাদ এর অর্থ বিপরীত করে।

যখন পর্যালোচনার ক্ষমতা কম হয়, তখন নিরাপত্তা ডকুমেন্টেশন এবং প্রধান-বাজারের ভাষাগুলিকে অগ্রাধিকার দিন এবং বাকিগুলি ঝুঁকি-ভিত্তিক স্তরের সাথে পরিচালনা করুন। পর্যালোচনা সম্পূর্ণভাবে বাদ দেওয়া একটি বিকল্প নয়: কোনো মানবিক পরীক্ষা ছাড়াই মেশিন অনুবাদ শেষ পর্যন্ত নিয়ন্ত্রিত সামগ্রীতে ব্যর্থ হবে।

FangService নতুন শক্তি প্রযুক্তিগত ডকুমেন্টেশনের জন্য সংশ্লিষ্ট ভাষায় ডোমেন পর্যালোচনা সংস্থান রয়েছে, নিরাপত্তা এবং সম্মতি ফাইলগুলি একটি প্রথম-শ্রেণীর-ডেলিভারযোগ্য প্রক্রিয়ার মাধ্যমে চালিত হয়। পণ্যের ধরন এবং লক্ষ্য বাজারগুলি আনুন এবং একটি নথির জন্য একটি শ্রেণিবিন্যাস পরিকল্পনা দিয়ে শুরু করুন।

স্টোরেজ ডকুমেন্টেশনের সবচেয়ে কঠিন অংশ: এক সেট ডেটা, অনেক পাঠক

স্টোরেজ প্রকল্পে অস্বাভাবিক সংখ্যক পক্ষ জড়িত — মালিক, EPC ঠিকাদার, গ্রিড কোম্পানি, অপারেশন দল, ফায়ার রিভিউয়ার। তারা একই সিস্টেমকে সম্পূর্ণ ভিন্ন অগ্রাধিকারের সাথে দেখে। গ্রিড কোম্পানি গ্রিড সংযোগ পরামিতি এবং সুরক্ষা সেটিংস পড়ে; অপারেশন ফল্ট কোড এবং প্রতিস্থাপন পদ্ধতি পড়া; মালিক অপারেটিং খরচ এবং ওয়ারেন্টি সীমানা পড়ে। একটি ব্যাপক প্রযুক্তিগত ম্যানুয়াল হিসাবে লিখিত, নথিটি তাদের কোনটিই পরিবেশন করে না; শুধুমাত্র অপারেশনের জন্য লিখিত, গ্রিড কোম্পানি এটি গ্রহণ করবে না। এর মধ্য দিয়ে উপায় হল লেয়ারিং: প্যারামিটার টেবিলগুলি মাস্টার ডকুমেন্ট তৈরি করে, প্রতিটি ভূমিকা তার নিজস্ব দ্রুত নির্দেশিকা পায়, সংখ্যায়ন সামঞ্জস্যপূর্ণ, এবং পুরো চেইনটি পুনর্বিবেচনার সময় একসাথে আপডেট হয়।

রিভিশন সিঙ্ক্রোনাইজেশন হল দ্বিতীয় ফাঁদ। একটি BMS ফার্মওয়্যার আপগ্রেড যা ফল্ট কোড যোগ করে এবং অপসারণ করে, যদি শুধুমাত্র মাস্টার ম্যানুয়ালে পরিবর্তন করা হয়, ভূমিকা-নির্দিষ্ট নির্দেশিকাগুলিকে একটি পুরানো সংস্করণে ছেড়ে দেয় এবং ক্ষেত্রটি একটি পুরানো কোড টেবিলের বিপরীতে নতুন ফার্মওয়্যার সন্ধান করে। FangService এই প্রকল্পগুলির সাথে শব্দকোষ এবং সংস্করণ নম্বরগুলিকে আবদ্ধ করে, একটি সংশোধনের সুযোগে প্রতিটি প্রাপ্ত নথিকে কভার করে এবং প্রধান সংশোধনগুলির জন্য একটি পরিবর্তনের সারাংশ পৃষ্ঠা জারি করে যাতে ক্লায়েন্টের অপারেশন দল সরাসরি এটি থেকে প্রশিক্ষণ সামগ্রী আপডেট করতে পারে।

টেকনিক্যাল ডকুমেন্টেশনের সম্পদ নির্ধারণ করে বছর-তিনটি খরচ

এনার্জি-স্টোরেজ ডকুমেন্টেশনের একটি সংজ্ঞায়িত বৈশিষ্ট্য রয়েছে: একটি দীর্ঘ জীবনচক্রের বিকাশ, ডেলিভারি এবং অপারেশন, অনেক দল এবং অনেক সংস্করণ সহ। যে প্রকল্পগুলি ডকুমেন্টেশনকে এক-বার ডেলিভারিযোগ্য হিসাবে বিবেচনা করে সেগুলি তিন বছরে বারবার এটিকে পুনঃলিখন করে — অপারেশনগুলি একটি নতুন ফর্ম্যাট চায়, ক্লায়েন্ট একটি নতুন টেমপ্লেট চায়, একটি নতুন বাজার একটি নতুন ভাষা চায় এবং প্রতিবার পুরানো ফাইলগুলি থেকে বিষয়বস্তু খনন করা হয়৷

সম্পদায়ন মানে প্রথম খসড়া থেকে পুনঃব্যবহারের জন্য ডিজাইন করা: সামঞ্জস্যপূর্ণ কাঠামো, স্বাধীন মডিউল, স্থিতিশীল সংখ্যায়ন, নিয়ন্ত্রিত পরিভাষা, সনাক্তযোগ্য সংস্করণ। একবার সেগুলি জায়গায় হয়ে গেলে, একটি ভাষা যোগ করা গুণন এবং একটি ভূমিকা যোগ করা হল সংমিশ্রণ, পুনর্লিখনের পরিবর্তে। সামনে পরিপাটি করে ব্যয় করা সময় পরবর্তী প্রতিটি পুনঃব্যবহারের উপর ফিরে আসে।

FangService ডেলিভারি এবং চলে যাওয়ার পরিবর্তে প্রজেক্টের অংশ হিসাবে শব্দ বেস, অনুবাদ মেমরি এবং সংস্করণ করার নিয়মগুলি সরবরাহ করে৷ ক্লায়েন্ট যা পায় তা কেবল অনুবাদ নয় বরং একটি সম্পদ যা কাজ করে, যা একটি ছোট দলের জন্য প্রায়শই ইউনিট-মূল্য ছাড়ের চেয়ে বেশি মূল্যবান।