테크니컬 라이팅
-
친절한 듯 불친절한 설명서테크니컬 라이팅 2022. 4. 28. 15:47
M사의 I 시스템이 H사의 제품에 포함된다. I 시스템의 아주 많은 화면에서 "매뉴얼"이라는 하위 메뉴가 제공된다. 그 메뉴를 선택하면 QR 코드가 나타난다. 스마트폰으로 QR 코드를 찍으면 웹 페이지가 열린다. 그 웹 페이지에, I 시스템에 대한 매뉴얼의 일부인데, 현재 화면에 대한 설명이 들어 있다. 이것이 매력적인 발상인가? 많은 사람들에게 그렇게 보일 것 같다. 그런데 이 접근에서 종래의 전제를 바꾸어야 한다는 압박이 자연스레 생긴다. 누구도 사용자들이 설명서를 처음부터 차례대로 읽는다고 가정하지 않는다. 그래도 우리는 그렇게 전제한다. 이를테면 스마트폰으로 음악 스트리밍 서비스를 이용하는 방법에 대한 설명에서 데이터 통신이나 와이파이에 대한 설정을 언급하지는 않는다. 그것은 이미 적절하게 준비되..
-
enable과 activate테크니컬 라이팅 2022. 4. 14. 16:21
With this option set to on, the head-up display is enabled. To activate the head-up display, press the HUD button. 구글뿐만 아니라 카카오와 파파고도 enable과 activate를 모두 "활성화"로 옮긴다. 많은 전자 장치들의 상태가 이렇게 전환될 수 있다. disabled -> (enable) -> operational but inactive -> (activate) -> operative activate/deactive를 활성화/비활성화로 옮기는 게 좋을 것 같다. disabled나 inactive나 매한가지로 작동하지 않는 상태이니, disable도 비활성화로 옮기는 것에 대과가 없을 것 같다. 문제는 ena..
-
그림 캡션에 대하여테크니컬 라이팅 2022. 3. 25. 10:08
논문과 같은 학술적인 문서에서는, 주장 또는 증명의 근거로서, 다수의 그림, 표, 수식이 등장하고, 그 각각의 것들이 대조와 비교를 위해 언급되어야 하므로 그림 번호와 수식 번호가 필요하다. 역사 책에서는 독자의 이해를 돕기 위한 보조 자료로서 그림들이 사용된다. 그런 책에서는 대개 그림 번호가 불필요한데, 번호가 없는 캡션을 legend라고 한다. 유발 하라리의 "사피엔스"나 칼 세이건의 "코스모스" 같은 책에서 그림들을 모조리 뺀다고 해도 그 책들의 가치가 조금도 저하되지 않는다. 이렇듯, 그림이 차지하는 지위가 책의 성격에 따라 다르다. 나는 매뉴얼 같은 문서에서 그림 캡션이 필수적이라기보다 오히려 군더더기라 생각한다. 매뉴얼에서 그림들은 증명을 위한 근거도 아니고, 없어도 무방한 보조 자료도 아니..
-
문서 도구도 문제다.테크니컬 라이팅 2022. 3. 18. 11:37
나는 워드, 프레임메이커, 마크다운(깃허브 지킬), 쓰리래빗츠, 인디자인, (주피터 노트북을 포함하여) 스핑크스, 레이텍을 사용하는 프로젝트를 한 번 이상 수행했다. 어느 것 하나 단순하지 않다. 지킬 설정은 쉽지 않지만, 마크다운이 제일 쉽다고 말할 수 있다. 하지만 그것이 제공하는 한정적인 문서 요소들에 만족하기가 쉽지 않다. 그것의 대척점에 있는 것이 인디자인이다. 인디자인은 테크니컬 라이터가 쓸 만한 도구가 절대 아니다. 디자이너가 스타일 템플릿을 만들어줘도 그렇다. 좀 과장해서 말하자면 일러스트레이터로 문서를 만드는 느낌이다. 달리 말하자면, 테크니컬 라이터가 쓰는 도구는 마우스를 덜 쓸수록 좋다. 쓰리래빗츠는 마크다운과 유사하면서도 많은 문서 요소들을 제공한다. 소프트웨어에 친숙하지 않은 사람..
-
왼쪽 또는 오른쪽테크니컬 라이팅 2021. 9. 27. 14:47
관음봉 쪽에서 능선을 타고 (그림에서 1의 방향으로부터) 이 곳으로 내려왔을 때 약간 어리둥절했다. 삼불봉으로 이어지는 오르막이 이 지점에서 시작될 것 같은데, 내리막길만 (그림에서 2의 방향) 보였기 때문이다. 계곡 쪽을 바라보며 쉬고 있는 사내에게 길을 묻자 그가 "왼쪽"이라고 답했다. 산에는 돌아가는 길들이 흔한지라 그의 말을 믿고 2의 방향으로 내려갔다.약 40 분 뒤에 2 킬로미터 가까이 걸어, 저 봉우리를 거쳐 이 곳으로 되돌아왔다. 반대쪽에서 저 봉우리를 오를 때 그가 내게 틀린 방향을 알려주었다고 생각했지만, 그의 말이 거짓이 아님을 깨달았다. 그와 나 사이에는 커다란 무덤이 있었고, 그래서 그의 관점에서 분명 "왼쪽"에 있는 길이, 게다가 내리막이어서, 내게 보이지 않았다. 그가 "11시..
-
테크니컬 라이터와 일러스트레이터테크니컬 라이팅 2021. 9. 15. 10:54
얼마나 많은 회사들이 테크니컬 라이터를 고용했을까? 드물 것이다. 얼마나 많은 제조사들이 테크니컬 일러스트레이터를 고용했을까? 거의 없을 것이다. 내가 테크니컬 라이터의 경력을 시작할 때 삽화가 해결하기 가장 어려운, 불가능에 가까운, 문제 중의 하나였다. 간단한 다이어그램은 어설프게나마 그린다 해도, 휴대폰 배터리를 교체하는 것과 같은 그림은 테크니컬 라이터가 할 수 있는 일이 결코 아니다. 테크니컬 라이터 입장에서 문서화 서비스 회사의 좋은 점은 테크니컬 일러스트레이터와 편집 디자이너의 도움을 받을 수 있다는 것이다. 그들이 여럿일 때, 몇 가지 프로젝트를 함께 수행한 뒤에 서로에 대한 평판을 갖게 된다. "아무개가 가장 빨리 처리한다." "아무개가 한 일에는 손댈 게 거의 없다." 이것이 최고의 찬..
-
파이프, 튜브, 호스테크니컬 라이팅 2021. 9. 13. 15:06
파이프의 가장 중요한 크기는 내경이다. 내경 또는 단면적을 중시하는 까닭은 체적을 구하기 위해서이다. 체적을 알아야 운반된 물, 가스 또는 석유의 가격을 계산할 수 있을 것이다. 파이프는 원통형이고 규격화된 크기로 생산된다. 파이프는 유연하지 않다. 튜브는 주어진 시간 동안 얼마나 많은 양을 보낼 수 있는지 따지지 않는다. 그래서 튜브의 규격은 내경이 아니라 외경이다. 튜브의 형태와 재질은 파이프보다 훨씬 더 다양한다. 유리관도 튜브이다. 파이프는 대규모 구조물에서 사용되는 반면 튜브는 상대적으로 작은 규모에서 사용된다. 예를 들어, 한 공장에서 탱크로부터, 파이프가 아니라, 튜브를 통해 질소 가스가 여러 장비로 공급된다. 파이프처럼 유연하지 않은 튜브도 있고, 호스처럼 유연한 튜브도 있다. 호스는 유연..