테크니컬 라이팅
-
SAE J2008테크니컬 라이팅 2024. 1. 16. 14:10
J2008이 뭘까? The goal of SAE J2008 is to enable manufacturers to standardize vehicle service information in order to increase technician familiarity and reduce search time with easy data retrieval. 이보다 더 상세한 설명을 찾기 어렵다. SAE(Society of Automotive Engineers)가 만들었기 때문에, 자동차 업체들만이 사용했기 때문에, 널리 알려지지 않은 것 같다. J2008은 XML 또는 SGML 형식의 문서 표준으로 보이는데, 자동차 업체들이 서비스 매뉴얼을 만드는 데에 J2008을 오래 동안 사용해온 듯하다. 이것은 내가 웹에서..
-
문서들은 텍스트 포맷으로 작성되어야 한다.테크니컬 라이팅 2023. 11. 2. 10:03
함께 퇴근하던 동료가 내게 물었다 "고객이 어떤 내용을 추가해달라고 할 때, 마땅한 자리를 찾기 어려울 때 짜증나지 않아요?" 전혀. 하지만 그녀가 왜 그렇게 말하는지 이해한다. 나는 레이텍을 사용하고 그녀는 워드를 사용한다. 워드 파일을 납품하는지는 모르겠다. 대개의 경우 인디자인으로 조판하여 납품한다. 인디자인은 테크니컬 라이터가 쓸 만한 도구가 아니다. 내가 설령, 그럴 생각이 전혀 없지만, 능숙하게 다룰 수 있다고 해도, 인디자인은 최악의 선택지이다. 모든 위지윅 포맷이 테크니컬 라이터에게 나쁘다. 작성 중인 문서의 구조를 크게 바꾸기가 매우 성가시기 때문이다. 나는 수시로 바꾼다, 구조도, 용어도, 표현도. 질의와 의견도 내키는 대로 추가한다. 테크니컬 라이터는 그렇게 할 수 있어야 한다. 왜냐..
-
메뉴를 choose 또는 select테크니컬 라이팅 2023. 10. 26. 16:04
Choose the Export menu item in the File menu. 이렇게 길게 쓰는 것을 아무도 선호하지 않는다. 그래서 아래처럼 짧게 쓴다. Click (또는 Tap) the File > Export menu. 이와 같은 표현을 깊이 고민하지 않고 즐겨 써왔지만, 부적절할 것이라는 짐작은 하고 있었다. 왜냐하면 문법에 따라 해석하자면, 저것은 "File > Export"라고 이름이 붙은 메뉴를 누르라는 것이기 때문이다. 마이크로소프트도 애플도 "the"와 "menu"를 쓰지 않는다. 애플: Choose Edit > Find > Find Next. 마이크로소프트: Select Accounts > Other accounts > Add an account. 하지만 여기에 차이가 있다. 애플은..
-
Documentation과 문서화테크니컬 라이팅 2023. 7. 26. 09:55
챗지피티의 아래와 같은 설명에 따르면, documentation을 "문서화"로 옮기는 것이 적절해 보인다. Documentation, on the other hand, refers to the process of creating, managing, and maintaining documents or information related to a specific subject, project, process, software, or any other endeavor. It involves the practice of recording important details, instructions, procedures, or guidelines to provide clarity, guidance, and refer..
-
공차 중량테크니컬 라이팅 2023. 4. 17. 09:44
우리말에 비해 영어에서 기술적 명칭들이, windshield처럼, 대상을 정확하게 가리키는 편이다. 그런데 "공차 중량"을 나타내는 curb weight는 예외이다. 이 표현의 사용을 1930 년대에도 찾을 수 있다고 한다. curb는 차도 가장자리에 설치된 연석을 가리킨다. curb weight가 어떻게 공차 중량을 뜻하게 되었을까? 차가 길가에 주차되어 있을 때, 주행 가능하지만 사람도 없고 짐도 없으니, 그 상황에 있는 차가 빈 차라고 본 모양이다. 여기에서 주행 가능하다는 것이 중요하다. 연료, 엔진 오일, 냉각수가 채워져 있고 예비 타이어와 공구도 갖춰져 있음을 의미한다.
-
Pound테크니컬 라이팅 2023. 4. 17. 09:28
Pound는 영국에서 사용되는 무게 단위이자 화폐이다. 화폐로 사용될 때는 sterling을 뒤에 붙인다. 1 pound sterling이 무게 1 파운드의 은과 같은 가치를 가리켰던 듯하다. 오늘 1 파운드는 그에 크게 못 미쳐 1620 원이다. 그런데 무게 파운드를 나타내는 기호는 왜 P가 아니고 L일까? 이것은 라틴어 libra pondo에서 온 말인데, "저울(천칭)로 잰 무게"를 뜻한다고 한다. libra의 복수는 librae이다. 단수든 복수든 lb.가 축약어이기 때문에 lb.로 써야 한다. 많은 사람들이 복수를 나타내기 위해 lbs.라고 쓰지만, 그렇게 쓰는 것은 용법에 맞지 않다,
-
DeepL테크니컬 라이팅 2023. 4. 11. 14:29
동료들 중에 한 젊은 친구가 실수를 했다. 번역본들을 조판하면서 네덜란드어와 독일어를 뒤섞었다. 몇몇 발음 부호를 제외하면 라틴 문자를 사용하는 언어들을 분간하는 것이 쉽지 않다. 게다가 네덜란드어는, 서로 대략 알아들을 정도로, 독일어와 유사하다고 한다. 이런 오류를 예방하는 방법으로서 구글 번역 API를 시도해보기도 했지만, 나는 이런 문제를 기술적으로 회피하기보다는 아래 이미지와 같이 여러 언어로 번역된 한 문장에 익숙해지는 것이 나으리라 생각한다. 구글 번역 API와 같은 것을 이용하더라도, 수백 페이지에서 다른 언어로 작성된 한두 문장을 찾아내는 프로그램을 만드는 것이 쉬울 것 같지 않고, 그런 프로그램의 사용이 합리적인 프로세스라고 보기도 어렵다. 아무튼 구글 번역이나 DeepL을 이용하여 문..