본문 바로가기

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

WTD 포틀랜드 2024 - 엔지니어링 원칙을 테크니컬 라이팅에 적용하기

반응형

컴퓨팅에서 블랙박스는 내부에서 어떤 일이 벌어지는지 몰라도 어떤 것을 입력했을 때 원하는 것을 출력할 수 있게 합니다. 하지만 엔지니어는 블랙박스에서 어떤 일이 벌어지는지 명확하게 알아야 합니다. 그리고 블랙박스에서 무슨 일이 일어나고 있는지 투명하게 설명하는 것은 테크니컬 라이터의 역할입니다.

테크니컬 라이터가 블랙박스에 대해 설명하기 위해서는 많은 것을 알아야 하는데 이런 정보를 특정 엔지니어에게서 한 번에 얻는 것은 쉽지 않습니다. 대부분 조직에서 엔지니어는 자신이 담당하고 있는 일부 부분에 대한 정보만 제공할 수 있기 때문이죠. 그리고 블랙박스가 하나만 있는 것이 아니라 여러 개로 나누어져 있을 수도 있습니다.

 

참고: 101 things I learned in engineering school(번역서 공학 학교에서 배운 101가지, 글램북스, 2015

 

공학 학교에서 배운 101가지 책을 보면 한쪽에는 그림, 그리고 다른 한쪽에는 짧은 문장으로 구성되어 있습니다. 이렇게 101가지 이야기가 담겨져 있는 작은 책입니다.

 

여러 개의 블랙박스를 엔지니어가 다룰 때는 순서대로 처리되는 것이 아닙니다. 여러 작업이 병렬로 진행이 되고 서로의 작업에 대해 정리된 내용이 공유될 필요가 있을 수도 있습니다. 이런 구조에서는 개발이 끝나고 완벽한 기술 자료가 나오고 그다음에 문서를 작성하는 것은 늦을 수 있습니다. 실시간으로 문서가 업데이트될 수 있는 구조가 필요하며 그러기 위해서는 테크니컬 라이터가 모든 일을 다 하기보다는 각 부분의 엔지니어가 문서화에 적극적으로 참여하고 협업하는 문화가 필요합니다.

 

발표자는 이것을 엔지니어링 디자인 프로세스에 적용해서 해결해보고자 합니다.

참고한 자료 중 하나는 "Designing the Future: How Engineering Builds Creative Critical Thinkers in the Classroom"이라는 책입니다. 번역서는 없네요.  또 하나는 "The Design Of Everyday Things"입니다. 도널드 노먼의 "디자인과 인간심리"로 번역된 책이죠.

 

엔지니어링 디자인 프로세스를 3단계로 간략하게 정리하면 다음과 같습니다. 그리고 각 단계에서 테크니컬 라이팅에서 어떤 일을 해야 하는지 솔루션을 제안합니다.

1. Know your problem

2. Know your options

3. Develop a solution

뭔가 제목이 거창하긴 하지만 기존에 테크니컬 라이팅에서 다루고 있는 각각의 주제들을 엔지니어링 디자인 프로세스에 껴맞춘 것 같은 느낌도 있구요. 도널드 노먼의 책 제목처럼 디자인이라는 것은 엔지니어링뿐 아니라 모든 것을 다루는 것이기 때문에 엔지니어링에서 나온 것을 테크니컬 라이팅에 적용한다는 식의 접근은 좀 애매합니다.

 

https://youtu.be/cOg9C_-CNOc?si=rWFJ2wDL4oeDvoCk

 

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

 

Mario Morales - Engineering Principles

 

www.flickr.com

 

728x90