신에너지 부문: 기술 문서 모범 사례

산업 인사이트 · 2001년 12월 15일
산업 인사이트현지화글로벌 확장기술 문서

아티클

2001년 12월 15일

배터리 및 에너지 저장 분야에서 가장 흔한 문서 오류는 오역이 아닙니다. 제품 라인이 앞서 나가면서 언어 버전이 표류하고 있습니다.

제품 라인당 하나의 신뢰할 수 있는 사양

배터리 및 스토리지 제품은 빠르게 반복되고 제품 라인은 빠르게 확장되며, 가장 일반적인 실패 모드는 잘못된 번역이 아니라 언어 버전이 서로 표류하는 것입니다. 중국 사양은 세 번의 개정을 거쳤으며 독일 사양은 여전히 ​​첫 번째 개정을 진행하고 있습니다. 잘못된 파일을 사용한 고객은 경미한 경우이며, 이로 인한 설치 오류는 사건입니다.

해결책은 제품 라인당 하나의 신뢰할 수 있는 사양을 유지하고 여기에서 모든 언어 버전을 파생시키는 것입니다. 모든 변경 사항은 먼저 소스에서 적용된 다음 푸시됩니다. 당연한 말처럼 들리지만 대부분의 팀 파일은 수십 개의 문서와 이메일에 분산되어 있으며 어느 것이 신뢰할 수 있는지 알 수 있는 방법이 없습니다.

단일 소스는 일관성을 해결하는 것 이상의 역할을 합니다. 즉, 현지화 가격을 예측할 수 있게 해줍니다. 소스가 안정적이면 번역 작업량을 예측할 수 있습니다. 출처가 매일 바뀌면 어떤 인용도 허구입니다.

문서 버전을 제품 버전에 바인딩

문서의 첫 번째 줄에는 해당하는 하드웨어 및 펌웨어 버전이 명시되어야 합니다. 신에너지 제품은 자주 개정되며, 동일한 모델이라도 배치 간에 매개변수 차이가 있을 수 있습니다. 오래된 설명서를 사용하여 새 장치를 장착하는 고객은 분쟁의 일반적인 원인입니다.

바인딩이란 문서 번호가 제품 버전 번호를 전달하고, 변경 사항이 단계적으로 버전을 변경하며, 제품 버전이 변경되면 문서를 재검토하고 재번역해야 하는 규칙이 있다는 것을 의미합니다. 해당 규칙은 프로젝트 시작 시 설정되어야 하며 각 사건 이후 재협상되어서는 안 됩니다.

구현의 어려움은 일반적으로 조직적입니다. 제품을 변경하는 팀과 문서를 관리하는 팀이 동일한 사람이 아닌 경우가 많습니다. 제품 변경 시 문서 검토가 자동으로 시작되도록 하려면 일부 메커니즘이 필요합니다. 수동으로 감시하는 것은 유지되지 않습니다.

안전 문서는 최고의 결과물입니다

배터리 제품은 열 폭주, 과충전, 운송 요구 사항 및 설치 규칙 등 대부분의 소비재보다 안전 위험이 더 높습니다. 그 중 하나라도 잘못 작성하면 부상 사고가 발생할 수 있습니다. 따라서 안전 장, 경고 번역 및 규정 준수 설명은 다른 콘텐츠와 동일한 기반으로 취급되어서는 안 됩니다. 이는 일류 결과물이며 별도로 예약, 검토 및 보관됩니다.

실제 프로젝트에서는 안전 관련 장이 짧고 단순해 보이기 때문에 이 섹션은 일상적으로 압축됩니다. 실제로 검토 요구 사항이 가장 높습니다. 번역은 정확할 뿐만 아니라 목표 시장의 규제 문구와도 일치해야 합니다. 경고문은 여러 관할권에서 공식을 지정했으며 문구의 작은 변경으로 법적 의미가 변경됩니다.

안전 문서에 대한 별도의 체크리스트를 작성하십시오. 모든 언어, 모든 규제 요구사항, 모든 버전을 하나씩 확인하십시오. 사고 발생 시 해당 체크리스트가 가장 강력한 증거가 됩니다.

언어별 검토: 이 레이어를 건너뛰지 마십시오.

신에너지 출시에는 일반적으로 많은 언어가 사용되므로 일반 제품보다 검토 압력이 더 높습니다. 도메인과 대상 언어를 이해하는 리뷰어는 일반 번역가와 자동 검사가 놓치는 문제를 포착합니다. 예를 들어 현지 표준에 따라 지정된 표현이 있는 용어, 현지 관례와 일치하지 않는 단위 형식, 문자 그대로 번역된 의미가 반대되는 문장 등이 있습니다.

검토 역량이 부족한 경우 안전 문서와 주요 시장 언어에 우선순위를 두고 나머지는 위험 기반 계층화로 처리합니다. 검토를 완전히 중단하는 것은 선택 사항이 아닙니다. 사람이 확인하지 않는 기계 번역은 규제 대상 콘텐츠에 대해 결국 실패하게 됩니다.

FangService에는 최고 수준의 제공 프로세스를 통해 실행되는 안전 및 규정 준수 파일과 함께 신에너지 기술 문서에 대한 해당 언어로 된 도메인 검토 리소스가 있습니다. 제품 유형과 대상 시장을 가져와 하나의 문서에 대한 분류 계획부터 시작합니다.

스토리지 문서화의 가장 어려운 부분: 하나의 데이터 세트, 많은 독자

스토리지 프로젝트에는 소유주, EPC 계약자, 전력망 회사, 운영팀, 화재 검토자 등 이례적으로 많은 당사자가 참여합니다. 그들은 완전히 다른 우선순위를 가지고 동일한 시스템을 봅니다. 전력회사는 전력망 연결 매개변수와 보호 설정을 읽습니다. 작업에서는 오류 코드 및 교체 절차를 읽습니다. 소유자는 운영 비용과 보증 범위를 읽습니다. 하나의 포괄적인 기술 매뉴얼로 작성된 이 문서는 그 어느 것도 제공하지 않습니다. 운영용으로만 작성된 경우 전력망 회사에서는 이를 승인하지 않습니다. 방법은 계층화입니다. 매개변수 테이블이 마스터 문서를 형성하고, 각 역할에 고유한 빠른 가이드가 있으며, 번호 지정이 일관되고, 개정 시 전체 체인이 함께 업데이트됩니다.

개정 동기화는 두 번째 함정입니다. 결함 코드를 추가하고 제거하는 BMS 펌웨어 업그레이드는 마스터 매뉴얼에서만 변경된 경우 역할별 가이드를 이전 버전에 남겨두고 현장에서 이전 코드 테이블을 기준으로 새 펌웨어를 검색하게 됩니다. FangService 이러한 프로젝트에 용어집과 버전 번호를 연결하고 개정 범위에 있는 모든 파생 문서를 다루고 주요 개정에 대한 변경 요약 페이지를 발행하여 고객의 운영 팀이 교육 자료를 직접 업데이트할 수 있도록 합니다.

기술 문서 자산화로 3년차 비용 결정

에너지 저장 문서에는 많은 당사자와 다양한 버전이 포함된 개발, 제공 및 운영에 걸친 긴 수명주기라는 정의적인 특징이 있습니다. 문서를 일회성 결과물로 취급하는 프로젝트는 3년차에 문서를 반복적으로 다시 작성하게 됩니다. 운영팀은 새로운 형식을 원하고, 클라이언트는 새로운 템플릿을 원하고, 새로운 시장은 새로운 언어를 원하며, 콘텐츠가 이전 파일에서 발굴될 때마다.

자산화란 일관성 있는 구조, 독립적인 모듈, 안정적인 번호 지정, 제어된 용어, 추적 가능한 버전 등 첫 번째 초안부터 재사용할 수 있도록 설계하는 것을 의미합니다. 일단 이러한 요소가 마련되면 언어를 추가하는 것은 다시 작성하는 것이 아니라 곱셈이고 역할을 추가하는 것은 조합입니다. 이후 재사용할 때마다 앞부분을 정리하는 데 소요된 시간이 반환됩니다.

FangService 용어 기반, 번역 메모리 및 버전 관리 규칙을 전달하고 떠나는 것이 아니라 프로젝트의 일부로 전달합니다. 클라이언트가 받는 것은 번역뿐 아니라 지속적으로 작동하는 자산입니다. 소규모 팀의 경우 단가 할인보다 더 가치 있는 경우가 많습니다.

맞춤 솔루션이 필요하신가요?

귀하의 적용 시나리오와 용량 요구 사항을 알려주시면 적합한 솔루션을 매칭하고 24시간 이내에 견적을 제공해 드립니다.

무료 견적 받기