بخش انرژی های نو: بهترین شیوه های مستندسازی فنی

مقاله

5 دسامبر 2024

در ذخیره سازی باتری و انرژی، رایج ترین خرابی اسناد، ترجمه اشتباه نیست. این نسخه های زبانی است که از هم جدا می شوند زیرا خط تولید از آنها جلوتر است.

یک مشخصات معتبر در هر خط محصول

محصولات باتری و ذخیره‌سازی سریع تکرار می‌شوند و خطوط تولید به سرعت گسترش می‌یابند، و رایج‌ترین حالت خرابی ترجمه اشتباه نیست، بلکه نسخه‌های زبانی از هم دور می‌شوند. مشخصات چینی از طریق سه تجدید نظر انجام شده است و آلمانی هنوز در اولین است. مشتری که از فایل اشتباه استفاده می کند جزئی است، خطای نصب آن یک حادثه است.

راه حل این است که یک مشخصات معتبر در هر خط محصول حفظ شود و هر نسخه زبانی از آن استخراج شود. هر تغییری ابتدا در منبع ایجاد می شود و سپس خارج می شود. این امر بدیهی به نظر می رسد، با این حال فایل های اکثر تیم ها در ده ها سند و ایمیل پراکنده هستند و هیچ راهی برای تشخیص معتبر بودن کدام یک وجود ندارد.

منبع واحد بیش از حل یکنواختی انجام می دهد: قیمت گذاری بومی سازی را قابل تخمین می کند. وقتی منبع ثابت باشد، حجم کار ترجمه قابل پیش بینی است. وقتی منبع روزانه تغییر می کند، هر نقل قولی تخیلی است.

اتصال نسخه سند به نسخه محصول

خط اول یک سند باید مشخص کند که با کدام سخت افزار و نسخه سیستم عامل مطابقت دارد. محصولات انرژی جدید اغلب مورد بازبینی قرار می گیرند و حتی همان مدل ممکن است تفاوت پارامترهای بین دسته ها را داشته باشد. مشتریانی که یک واحد جدید را با یک دفترچه راهنمای قدیمی نصب می کنند، یک منبع رایج اختلاف است.

صحافی به این معنی است که شماره سند حاوی شماره نسخه محصول است، تغییرات به صورت مرحله به مرحله نسخه را نشان می دهد، و قانونی وجود دارد که برای آن اسناد باید دوباره بررسی شوند و زمانی که نسخه محصول تغییر می کند، دوباره ترجمه شوند. این قانون باید در شروع پروژه تنظیم شود، نه اینکه بعد از هر حادثه دوباره مذاکره شود.

دشواری پیاده سازی معمولاً سازمانی است - تیمی که محصول را تغییر می دهد و تیم مدیریت اسناد اغلب افراد یکسانی نیستند. برخی مکانیسم ها برای تغییر محصول مورد نیاز است تا بازبینی سند به طور خودکار انجام شود. تماشای آن به صورت دستی قابل اجرا نیست.

اسناد ایمنی یک دسته اول قابل تحویل است

محصولات باتری نسبت به اکثر کالاهای مصرفی خطر ایمنی بالاتری دارند: فرار حرارتی، شارژ بیش از حد، الزامات حمل و نقل و قوانین نصب. هر یک از آنها به اشتباه نوشته شود می تواند باعث آسیب شخصی شود. بنابراین، فصل‌های ایمنی، ترجمه‌های هشداردهنده و بیانیه‌های انطباق نباید مانند سایر محتواها در نظر گرفته شوند. آنها قابل تحویل درجه یک هستند، برنامه ریزی شده، بررسی و به طور جداگانه بایگانی می شوند.

در پروژه های واقعی، این بخش به طور معمول فشرده می شود، زیرا فصل های ایمنی کوتاه هستند و ساده به نظر می رسند. الزامات بررسی آنها در واقع بالاترین است - ترجمه نه تنها باید صحیح باشد بلکه باید با عبارت نظارتی بازار هدف مطابقت داشته باشد. بیانیه‌های اخطار، فرمول‌بندی‌هایی را در حوزه‌های قضایی متعددی تعیین کرده‌اند، و یک تغییر کوچک در عبارت، معنای حقوقی را تغییر می‌دهد.

یک چک لیست جداگانه برای اسناد ایمنی بسازید: هر زبان، هر الزام قانونی، هر نسخه، یک به یک علامت گذاری شده است. در یک حادثه، آن چک لیست قوی ترین مدرک شماست.

بررسی هر زبان: این لایه را نادیده نگیرید

راه اندازی انرژی های جدید معمولاً شامل تعداد زیادی زبان است، بنابراین فشار بازبینی بیشتر از یک محصول معمولی است. بازبینانی که دامنه و زبان مقصد را می‌فهمند، مشکلاتی را می‌بینند که مترجمان عادی و چک‌های خودکار از قلم می‌افتند - برای مثال عبارتی با رندر مشخص در یک استاندارد محلی، قالب واحدی که با قرارداد محلی مطابقت ندارد، یا جمله‌ای که ترجمه تحت اللفظی آن معنای آن را معکوس می‌کند.

وقتی ظرفیت بازبینی کوتاه است، اسناد ایمنی و زبان‌های اصلی بازار را در اولویت قرار دهید و بقیه را با ردیف‌بندی مبتنی بر ریسک مدیریت کنید. کنار گذاشتن بررسی به طور کلی یک گزینه نیست: ترجمه ماشینی بدون بررسی انسانی در نهایت در محتوای تنظیم شده با شکست مواجه می شود.

FangService دارای منابع بررسی دامنه به زبان‌های مربوطه برای مستندات فنی انرژی جدید است، با فایل‌های ایمنی و انطباق که از طریق فرآیند تحویل درجه یک اجرا می‌شوند. نوع محصول و بازارهای هدف را بیاورید و با یک طرح طبقه بندی برای یک سند شروع کنید.

سخت ترین بخش اسناد ذخیره سازی: یک مجموعه داده، تعداد زیادی خواننده

پروژه های ذخیره سازی شامل تعداد غیرمعمولی از طرفین است - مالک، پیمانکار EPC، شرکت شبکه، تیم عملیات، بازبینان آتش نشانی. آنها به یک سیستم با اولویت های کاملاً متفاوت نگاه می کنند. شرکت شبکه پارامترهای اتصال به شبکه و تنظیمات حفاظتی را می خواند. عملیات کدهای خطا و روش های جایگزینی را می خواند. مالک هزینه های عملیاتی و مرزهای گارانتی را می خواند. این سند که به عنوان یک کتابچه راهنمای فنی جامع نوشته شده است، به هیچ یک از آنها کمک نمی کند. فقط برای عملیات نوشته شده است، شرکت گرید آن را نمی پذیرد. راه حل لایه بندی است: جداول پارامترها سند اصلی را تشکیل می دهند، هر نقش راهنمای سریع خود را دریافت می کند، شماره گذاری ثابت است، و کل زنجیره با هم به روز رسانی می شود.

همگام سازی تجدید نظر دام دوم است. یک ارتقاء سیستم عامل BMS که کدهای خطا را اضافه و حذف می کند، اگر فقط در کتابچه راهنمای اصلی تغییر کند، راهنماهای مربوط به نقش را در نسخه قدیمی باقی می گذارد، و این فیلد در نهایت به جستجوی میان افزار جدید در برابر جدول کدهای قدیمی می رسد. FangService واژه نامه ها و شماره نسخه ها را به این پروژه ها متصل می کند، هر سند مشتق شده را در محدوده یک بازبینی پوشش می دهد، و یک صفحه خلاصه تغییرات را برای ویرایش های اصلی صادر می کند تا تیم عملیات مشتری بتواند مطالب آموزشی را مستقیماً از آن به روز کند.

دارایی اسناد فنی هزینه های سال سوم را تعیین می کند

اسناد ذخیره‌سازی انرژی دارای یک ویژگی مشخص است: چرخه عمر طولانی توسعه، تحویل و عملیات، با بسیاری از طرف‌ها و نسخه‌های بسیار. پروژه‌هایی که مستندات را به‌عنوان یک تحویل یکباره در نظر می‌گیرند، در نهایت در سال سوم مکرراً آن را بازنویسی می‌کنند – عملیات قالب جدیدی می‌خواهد، مشتری یک الگوی جدید می‌خواهد، یک بازار جدید یک زبان جدید می‌خواهد، و هر بار که محتوا از فایل‌های قدیمی استخراج می‌شود.

دارایی سازی به معنای طراحی برای استفاده مجدد از اولین پیش نویس است: ساختار سازگار، ماژول های مستقل، شماره گذاری پایدار، اصطلاحات کنترل شده، نسخه های قابل ردیابی. هنگامی که آن ها در جای خود قرار گرفتند، اضافه کردن یک زبان ضرب است و اضافه کردن یک نقش ترکیبی است، نه بازنویسی. زمان صرف شده برای مرتب کردن جلو در هر استفاده مجدد بعدی باز می گردد.

FangService اصطلاح پایه، حافظه ترجمه و قوانین نسخه‌سازی را به‌عنوان بخشی از پروژه به جای تحویل و خروج ارائه می‌کند. چیزی که مشتری دریافت می‌کند نه تنها ترجمه، بلکه دارایی‌ای است که به کار خود ادامه می‌دهد، که برای یک تیم کوچک اغلب بیش از یک تخفیف قیمت واحد ارزش دارد.