고객사의 B2B 기술 문서 컨설팅을 하다 보면 이런 질문을 많이 받습니다.
"도대체 템플릿이 무엇인가요?"
"템플릿만 있으면 기술 문서안의 내용을 작성하는데 전혀 문제가 없어야 하는 것 아닌가요?"
여러분들은 템플릿이 무엇이라고 생각하시나요?
템플릿이란 쉽게 이야기해서 여러분들이 기술 문서 내 기술 정보를 작성하실 때 도움을 줄 수 있는 '틀'과 같은 것입니다.
예를 들어서, 여러분들이 별 모양 빵을 1000 개 만든다고 가정해 봅시다.
여러분들이 별 모양 틀을 사용하지 않고 1000개의 빵을 직접 손으로 만든다고 했을 때, 그 1000개의 빵이 1cm 도 틀리지 않는 동일한 별 모양 빵이 나올까요?
물론, 실력이 좋아서 그렇게 만들 수 있는 분도 계시겠지만, 일반적인 사람의 능력을 고려했을 때 100% 동일하게 만드는 것은 어려울 것이며 시간 또한 상당히 많이 걸릴 겁니다.
B2B 테크니컬 라이팅에서 템플릿이란 빵을 만들 때에 사용하는 별 모양의 틀과 동일한 것입니다.
여기서 틀이란, 1, 1.1, 1.1.1, Sub-Title A-1-1-1 과 같은 서식을 의미합니다.아래를 보시면 바로 이해가 가시겠죠?
자, 다시한번 별 모양 빵을 만드는 것으로 돌아가서 말씀 드리겠습니다.별 모양 틀만 있으면 빵을 맛있게 만들 수 있는 것일까요?
그렇지 않겠죠. 별모양으로 예쁘게 만들었지만, 정작 맛을 보면 너무 퍽퍽하다든가, 너무 달다든가, 너무 버터가 많이 들어갔다든가 하면서 맛이 없을 수 있습니다.그러면, 별 모양 빵을 맛있게 만들려면, 여러분들이 맛있는 빵을 만드는 기술을 배우셔야 하겠죠?
자, 여러분 이해하셨나요?
B2B 테크니컬 라이팅에서도 템플릿만 있다고 해서 기술 문서 내용을 잘 쓰실 수 있는 것이 아닙니다.그 템플릿 안을 잘 채울 수 있도록, 즉 기술 문서 사용자가 기술 정보를 명확히 이해할 수 있도록 하기 위해서는 여러분들의 기술 문서 작성 능력을 꾸준히 향상시켜야 합니다.
앞으로는, 템플릿을 생각하실 때 모든 글이 작성 되어 있고 수치만 바꾸면 되는 것이 템플릿이다 라는 생각을 바꾸셔야 하겠죠?
디앤디는 여러분들의 B2B 기술 문서 작성에 대한 능력 배양과 해외 경쟁력을 위하여 꾸준히 노력하고 있습니다.
B2B 테크니컬 커뮤니케이션 기업, 디앤디
