본문 바로가기

테크니컬 라이팅/WTD 컨퍼런스

WTD 호주 2022 - 표준에 따라 기술 문서 작성하기

반응형

Shumin Chen은 싱가포르의 shufrans-techdocs라는 기술문서 전문 기업에서 STE(Simplified Technical English) 업무를 담당하고 있습니다. STE는 ASD-STE100라는 스펙으로 정의되어 있습니다. 2019년 출간된 "테크니컬 라이터가 되려는 당신에게"에서 간략하게 ASD-STE100를 소개하는 내용이 포함되어 있었습니다.

WTD에서는 주로 소프트웨어 산업의 기술 문서를 중심으로 다루다 보니 국제 표준에 대한 언급은 많이 없었는데 이번 세션에서는 최근 국제 표준 관련 트렌드에 대해 다루고 있습니다.

 

문서화의 중요성에 대해서는 많은 산업에서 강조되고 있지만 표준에 대해서는 무시되는 경향이 있습니다. 
ASD-STE100 같은 표준을 따르는 것은 테크니컬 라이터, 독자 모두에게 유익한 일입니다. 좀 더 명확하게 문서를 작성하고 독자는 쉽게 이해할 수 있는 것이죠.

 

예를 들어보면
In order to perform x installation process, please ensure that all of the following steps are done.
대신 To install x, do these steps. 이라고 쓰는 거죠.

 

다른 예로는
This document will guide you through the process of creating an XXX configuration.
대신 This document shows you how to prepare an XXX configuration.이라고 쓰는 겁니다.

STE를 사용하는 것은 비용 절감으로 이어집니다. 번역 시 계산되는 단어의 수를 줄이고 통제된 어휘를 사용함으로서 반복된 언어로 처리되어 기계 번역의 정확도를 높이고 전체적인 비용을 줄일 수 있습니다.

 

같은 영어 표현도 지역, 문화에 따라 다른 형태로 표현합니다. 

 

 

STE가 이를 완벽하게 해소하지는 못하지만 통제된 단어 내에서 문서를 작성하도록 교육하고 가이드하면 에디팅 작업이 줄어들고 마치 하나의 목소리처럼 만들어갈 수 있습니다.

 

 

항공 업계에서는 ASD-STE100 표준을 100% 준수해야 하지만 소프트웨어 산업에서는 70-80% 정도만 따르더라도 충분히 모두에게 좋은 문서를 만들 수 있습니다. 아마도 독자가 한정된 항공 업계 기술 문서와는 좀 다를 수 있다는 것입니다.

 

https://youtu.be/xKbg10gymI4

 

https://flic.kr/p/2o5amHd

 

Shumin - Sustainable Content for Software Documentation Powered by Simplified Technical English (STE)

 

www.flickr.com

 

아. 추가로 ChatGPT와 ASD-STE100을 한국어 기술 문서에 적용할 수 있을지 이야기 나누어보았습니다. 내용이 흥미로워 참고로 남겨봅니다.

 

ASD-STE100 표준을 알고 있나요?

ASD-STE100은 S1000D 문서 작성을 위한 국제 표준입니다. 이 표준은 항공우주 및 방어 산업에서 사용되며, 기술 문서 작성 및 관리를 위한 일관된 방법을 제공합니다.

ASD-STE100은 Simplified Technical English의 약자로, 이는 기술 문서 작성을 위한 간소화된 영어 언어 규칙을 정의합니다. 이 규칙은 문서 작성자와 독자 간의 의사소통을 개선하고 오해와 오류를 줄이는 데 도움이 됩니다.

ASD-STE100은 특정 용어, 구문, 순서 등의 사용을 제한하는 방법을 정의하며, 이를 준수하여 작성된 문서는 다른 사람들이 이해하기 쉽고 일관성이 유지됩니다. 이는 항공우주 및 방어 산업뿐만 아니라 다른 산업에서도 적용될 수 있는 유용한 규칙이 될 수 있습니다.

 

한국어로 기술 문서를 작성할 때 ASD-STE100 표준을 적용해볼 수 있을까요?

한국어로 작성된 기술 문서에서도 ASD-STE100 표준을 적용할 수 있습니다. 하지만 이 경우, 표준에서 정의된 영어 단어 및 규칙을 한국어에 맞게 변환하여 적용해야 합니다.

예를 들어, ASD-STE100 표준에서는 "use"라는 단어를 "utilize" 대신 사용하도록 규정하고 있습니다. 이 경우 한국어에서는 "사용하다" 대신 "이용하다"와 같은 말을 사용할 수 있습니다.

또한, ASD-STE100에서는 문장 구조, 단어 선택, 기술 용어 사용 등을 제한하는 규칙을 제공합니다. 이러한 규칙을 한국어에 맞게 적용하여 문서를 작성하면, 독자들이 이해하기 쉽고 일관성이 유지되는 기술 문서를 작성할 수 있습니다.

하지만, 한국어는 영어와 달리 교착어이며 문법적 특성이 다르기 때문에, ASD-STE100을 그대로 적용하기 보다는 적절한 수정과 번역이 필요할 수 있습니다.

 

혹시 한국어에 맞는 ASD-STE100 표준 정보를 찾을 수 있을까요?

ASD-STE100은 주로 항공우주 및 방어 산업에서 사용되는 표준으로서, 한국어에 대한 공식 번역이 존재하지 않습니다. 하지만, ASD-STE100의 영어 버전을 참고하여 한국어 문서를 작성할 때 유용한 팁이나 가이드 라인은 다음과 같습니다:

1. 간단하고 명확한 문장을 작성하십시오. ASD-STE100은 문장 길이와 복잡성을 제한하므로, 이를 한국어로 적용할 때도 가능한 간단하고 명확한 문장을 사용하십시오.

2. 일관된 용어를 사용하십시오. ASD-STE100은 일관성을 유지하기 위해 특정 용어의 사용을 규정합니다. 이를 한국어에 맞게 번역하고 일관성을 유지하는 것이 중요합니다.

3. 적절한 기술 용어를 사용하십시오. ASD-STE100은 기술 용어의 사용을 규정하므로, 한국어로 번역할 때도 적절한 기술 용어를 사용해야 합니다.

4. 문서 구조와 서식을 일관되게 유지하십시오. ASD-STE100은 문서 구조와 서식을 일관되게 유지하기 위한 규칙을 제공합니다. 이를 한국어로 번역할 때도 일관성을 유지하도록 노력하십시오.

5. 문서 검토를 수행하십시오. ASD-STE100은 문서 작성 시 검토를 권장합니다. 한국어로 번역할 때도 문서 검토를 수행하여 올바르게 번역되었는지 확인하고, 일관성을 유지할 수 있도록 하십시오.

따라서, 한국어로 기술 문서를 작성할 때는 ASD-STE100 표준을 참고하여 문서 작성의 일관성과 명확성을 높이는 것이 좋습니다.

728x90