Energy Sector Ekãl: Technical Documentation Best Practices

Bwebwenato

Tijemba 15, 2001

Ilo battery im energy storage, men eo elaptata an walok ilo documentation ejjab juon bōd in ukok. Ej kain kajin ko rej etal jen dron ke line in men ko rej ettor iman ir.

Juon melele eo ewor an maroñ ñan kajjojo laajrak in men ko rej wiakaki

Battery im men ko rej kejbãrok men ko rej mõkaj air oktak im men ko rej mõkaj air laplok, im wãwen eo elaptata an jorrãn ejjab juõn ukok eo ebwid ak kajin ko rej jebel jen don. Chinese specification eo emoj an kar etal ilo jilu kōkāāl ko im German ej bed wōt ilo eo moktata; juon ri wia ej kajerbal file eo ebōd ej dik, juon bōd in installation jen e ej juon jorrāān.

Men eo ej kōmmane ej ñan kejbãrok juon melele eo emman ñan kajjojo line in men ko im bōk aolep kajin ko jen e. Jabdewōt oktak ej kōmmane ilo jikin eo mokta innem jolok. Menin ej einwot an alikar, ak elaptata file ko an tiim ko rej bed ilo elōn peba ko im email ko, im ejelok ial in jelā ewi iaer ej maroñ.

Juon wōt jikin ej kōmman elaplok jen an kōmman bwe en jejjet: ej kōmman bwe en maroñ in wōr wōnan ilo jikin eo. Ñe jikin eo ej bed ie ej bed wot, joñan jerbal in ukok eo ej maroñ in kōtmene kake. Ñe unin ej oktak aolep raan, jabdewōt nan ko rejjab mol.

Bind Document Version ñan Product Version

Lain eo moktata ilo juon peba ej aikuj kwalok ta hardware im firmware version eo ej ekkar ñane. Menin kajur ko rekãl rej oktak ekkã air walok, im bareinwõt ejja model eo wõt emaroñ bõk oktak ko ikõtan batch ko. Ri wia ro rej likit juon unit ekãl ippāñ juon bok in tel eo etto ej juon un in aitwerõk.

Binding ej melelen bwe nomba in peba eo ej bōk nomba in version eo an men eo, oktak ko rej kōmman version eo ilo step eo, im ewōr juon kien ñan an document ko aikuj in bar lale im bar ukōte ñe juon version in product ej oktak. Kien in ej aikuj in kōmmane ilo jinoin jerbal eo, jab bar kōmmane elikin kajjojo men ko rej walok.

Apañ in kōmmane ej ekkā an walok ilo jukjuk in pād eo — tiim eo ej ukōt men eo im tiim eo ej lale peba ko ekkā aer jab armej ro wōt. Jet wāween ko rej aikuj in kōmmane ñan oktak in juon men ñan kōmman bwe en maroñ in etale peba ko ilo an make; lale kin peim ejjab dāpij.

Peba in Kōjparok ej juon men eo emman tata ñan lelok

Men ko rej kōmman jen battery ko rej bōk jorrāān ko relaplok jen men ko rej wiakaki: bwil im molo, elap wōnan, aikuj in bōktok im kakien ko ñan likit. Jabdewōt ian men kein rej jeje ilo jimwe emaron kōmman juon jorrāān ñan juon make. Innem chapter ko kin kejbãrok, ukok in kakkōl ko im nan in kamool ko rejjab aikuj in jerbal ilo ejja joñan eo wot einwot men ko jet; rej men ko remman tata, kar kōllaajrake, kar etale im likūt ilo jikin ko reoktak jen dron.

Ilo jerbal ko remol, mõttan in ej lukkun diklok, kinke chapter ko kin kejbãrok rej dik im einwõt bin. Aikuj ko aer ñan etale rej lukkun utiej tata — ukok eo ej aikuj jab jimwe wōt ak ej aikuj in ekkar ñan nan in kakien ko an jikin wia eo. Naan in kakkōl ko ewōr aer wāween ko ilo elōn jikin ko, im jidik oktak ilo naan ko ej ukōt meļeļe eo an kien.

Kōmman juon laajrak in lale eo ejenolok ñan peba in kejbãrok: kajjojo kajin, kajjojo menin aikuj ko an kien, kajjojo version, tick off juon kin juon. Ilo juon jorrāān, laajrak in etale eo ej kein kamool eo am ekajur tata.

Per-Language Review: Jab jolok laajrak in

New energy launch ko ekkã air bōk elap kajin ko, innem elaplok an armij ro etale jen juon men eo ekkā an walok. Ri-etale ro rej melele kin domain eo im kajin eo rej etale rej loe abañ ko me ri-ukok ro rejimwe im automated check ko rej likjab in loe — einwot juon nan eo ewōr juon an rendering ilo juon joñan eo an jikin eo, juon unit format eo ejjab errā ippān kien eo an jikin eo, ak juon sentence eo me ukok eo an ej ukōt melele eo an.

Ñe edik joñan maroñ in etale, likit moktata peba in kejbãrok im kajin ko relap, innem kōmmane men ko jet ilo joñan ko rej bedbed ion jorren ko. Kōtlok etale eo ejjab juon kālet: ukok in machine ilo ejelok armij ej lale enaj likjab ilo men ko rejejjet.

FangService ewōr an kein jerbal ko ñan etale domain ko ilo kajin ko rekkar ñan documentation ko rekāāl kōn energy technical, ippān safety im compliance file ko rej jerbal ilo juon wāween eo em̧m̧an tata. Bōktok kain men eo im jikin wia ko, im jino kin juon karōk in kōjenolok ñan juon peba.

Mõttan eo ekauwatata ilo Storage Documentation: Juon Set in Data, Elõñ Ri Riit ro

Jerbal in kejbãrok ej kitibuj elõñ armij ro — ri wia eo, ri jerbal eo an EPC, jikin jerbal eo an grid eo, tiim in jerbal eo, ri etale kijeek ro. Rej lale ejja jukjuk in pād eo wōt kōn men ko raorōk reoktak. Grid company eo ej riiti joñan ko an grid eo im joñan ko an kōjparok; jerbal ko rej riiti bōd ko im wāween ko ñan bōk jikin; ri wia eo ej riiti joñan wōnan jerbal im warranty ko. Kar jeje einwot juon bok in tel eo elap, peba in ejjab jerbal ñan jabdrewot ian men kein; jeje wōt ñan jerbal ko, grid company eo ejamin bōke. Wāween eo ej kōmmane ej laajrak: tebōl in parameter ko rej ejaak master document eo, kajjojo role ej bōk an make guide eo em̧ōkaj, numbering ej āinwōt juon, im aolepān chain eo ej kōkāāl ippān doon ilo iien kōkāāl.

Revision synchronization ej men eo kein karuo. Juon BMS firmware upgrade eo ej kobaik im jolok fault code ko, elañe kar oktak wot ilo master manual eo, ej likit role-specific guides ko ilo juon version eo etto, im field eo ej jemlok an lale firmware ekãl nae juon code table eo etto. FangService ej likit glossary ko im version number ko ñan project kein, ej kalibubu aolep document ko ilo scope in juon revision, im ej lelok juon peij in kōmeļeļe kin oktak ko ñan revision ko relap bwe tiim in jerbal eo an client eo en maroñ in update material in katak ko jen e.

Kōllaajrak Peba in Jerbal ko ej kōmman bebe kin wōnāān ko ilo yio eo kein kajilu

Energy-storage documentation ewōr juon an men eo ej kalikar: juon ien eo elap an mour ej bōk jikin kōmman, lelok im jerbal, ippāñ elōn party ko im elōn version ko. Project ko rej bōk documentation einwot juon men eo ej walok juon wōt alen rej jemlok im bar jeje ilo yio eo kein kajilu — operations ej kōnaan juon format ekãl, client eo ekõnan juon template ekãl, juon market ekãl ekõnan juõn kajin ekãl, im kajjojo ien men ko rej bõki jen file ko remotlok.

Assetising ej melelen kōmmane ñan bar kōjerbale jen draft eo moktata: structure eo ejjab oktak, module ko rej make iaer, numbering ko rejimwe, naan ko rejimwe, version ko remaroñ in lale. Ñe rej bed ilo jikier, kobaik juon kajin ej kōmman im kobaik juon jerbal ej kobaik, jen bar jeje. Iien eo kar jolok ñan karreo ej bar jeblak ilo aolep ien ko rej bar kajerbali.

FangService ej letok nan eo, melele in ukok im kakien ko einwot mõttan jerbal in jen an lelok im etal jen ijo. Ta eo ri wia eo ej bōk ejjab baj ukok ko wōt ak ej juon men eo ej jerbal wōt, eo ñan juon tiim edik ekkā an ļapļo̧k jān juon unit-price discount.