본문 바로가기

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

WTD 애틀랜틱 2023 - 단일 소스 용어집 구축하기

반응형

플랫폼 간에 같은 기능을 설명하기 위해 다른 용어를 사용하는 문제가 있습니다. 이런 문제를 해결하기 위해 다양한 조직 담당자들이 워킹그룹을 만들고 기존에 사용하던 용어, 정의를 모두 정리했습니다. 그리고 모든 토론 과정을 GitHub에 기록으로 남겼습니다. 

만들어진 용어집은 다양한 서비스에서 제공되기를 원했습니다. 기술지원포털뿐 아니라 번역 관리 시스템 등에서도 말이죠. 그리고 실제 서비스에서도 용어에 대한 정의를 확인할 수 있어야 했습니다. 이를 구현하기 위해서는 기계가 읽고 처리할 수 있는 단일 소스의 거대한 용어집이 구현되어야 했습니다. 

Hugo 같은 경우 기능을 확장하기 위해 Modules을 지원하고 있습니다. 그래서 용어집을 Hugo Module로 만들고 이를 각 서비스에서 가져와 사용하도록 구성했습니다.

 

 

yaml 형식에서 다양한 매개변수를 사용해 상황에 맞게 데이터를 적용할 수 있게 한 것도 특징입니다.

 

 

단일 소스를 가져와서 다양한 서비스에서 용어에 대한 설명을 보여줄 수 있습니다. 개발자 사이트에 용어집 페이지로 구성될 수도 있고 문서 내 용어에 대한 툴팁 형태로도 제공할 수 있습니다.

 

아무래도 Hugo 시스템을 기반으로 설명하다 보니 후반부에는 좀 기술적인 내용이 되어버렸는데요. 용어집을 구현하는 방식에 대한 아이디어 차원에서 참고하면 좋을 듯합니다.

 

국내에서도 LINE에서 용어집 구축에 대한 경험을 공유한 자료가 있습니다. 같이 참고해보세요.

사내 용어 사전, LINE Words 오픈 여정기

https://engineering.linecorp.com/ko/blog/glossary-project-line-words-open

 

용어집을 만들 때 참고했다는 사이트가 Terminology for Large Organizations 인데요. 사이트 내에서 가이드 문서도 잘 정리해놓았더군요. 역시 참고하길 권해드립니다.

https://www.terminorgs.net/

 

https://youtu.be/3YPisLxVy2I?si=MkIKRz86wbesdSZi

 

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

 

oneGlossaryToRuleThemAll

 

www.flickr.com

 

728x90