인포그랩이 인프라 접근 관리 도구 Teleport의 전체 공식 기술 문서를 한글로 제공합니다. ‘Teleport 공식 기술 문서 한글판 by 인포그랩(이하 Teleport 공식 기술 문서 한글판)’에서 이를 확인할 수 있는데요.

안녕하세요. 인포그랩 프로덕트 팀에서 백엔드 엔지니어로 근무하는 Andy입니다.

인포그랩이 글로벌 기업용 메신저 Mattermost의 전체 공식 기술 문서를 한글로 제공합니다.

인포그랩은 올해 2월 ‘GitLab 공식 기술 문서 한글판 by 인포그랩(이하 GitLab 공식 기술 문서 한글판)’이라는 신규 서비스를 선보였습니다.

인포그랩이 최근 GitLab의 전체 공식 기술 문서를 한글로 번역한 신규 서비스를 선보였습니다. 바로 ‘GitLab 공식 기술 문서 한글판 by 인포그랩(이하 GitLab 공식 기술 문서 한글판)’인데요.

‘GitLab 공식 기술 문서 한글판 by 인포그랩(이하 GitLab 공식 기술 문서 한글판)’은 미국 연구 기업 OpenAI의 생성형 인공지능(AI) 모델 gpt-3.5-turbo-1106으로 GitLab 공식 기술 문서 총 2000여 개를 한글로 자동 번역해 제공하는 서비스입니다.

IT 기업의 기술 블로그는 단순히 기술 지식과 정보를 나누는 통로에만 그치지 않습니다. 이는 기업의 기술력과 개발 문화를 대외로 드러내는 창구이기도 한데요.

‘프롬프트 엔지니어링(prompt engineering)’은 ChatGPT나 뤼튼, DALL·E, Stable Diffusion 등 생성형 인공지능(AI) 도구에 구체적인 질문 또는 자세한 요구사항을 텍스트(프롬프트)로 입력해 결과물을 얻는 행위입니다. 결과물은 텍스트나 이미지 등으로 나오는데요. 이는 짧은 시간 안에 분량이 길거나, 표현이 정교한 콘텐츠를 빠르게 생산하는 데 도움이 되죠.

오늘날 테크니컬 라이팅 분야에서도 프롬프트 엔지니어링을 업무에 활용하도록 다양한 방법을 모색하고 있는데요. 기술 문서 기획, 개요 작성, 문서 검수, SEO(검색 엔진 최적화) 태그 생성 등 여러 업무에 프롬프트 엔지니어링을 접목하는 방안이 제시되고 있습니다. 테크니컬 라이팅 업무에 활용할 만한 프롬프트 제안도 여럿 나오고 있죠. 저는 DevOps 기업 테크니컬 라이터로서 이를 활용해 업무 생산성과 효율성을 높이는 방안을 두고 고민하고 있습니다.

테크니컬 라이팅은 테크니컬 라이터만의 일은 아닌데요. 엔지니어, 개발자, 프로덕트 매니저, 마케터, 세일즈 담당자, 홍보 담당자 등 IT 기업의 모든 직무 담당자가 테크니컬 라이팅 업무를 수행합니다. 기술 문서는 제품 개발과 사용을 위한 모든 문서와 자료인데요. API 문서, 가이드, README 파일, 릴리즈 노트, 회사 소개서, 제안서, 보도자료 등 IT 기업 구성원이 작성하는 문서가 이와 관련됐죠.

이에 테크니컬 라이팅은 테크니컬 라이터를 포함한 모든 직무 담당자가 수행하는 업무고요. IT 기업 종사자라면 누구나 ‘프롬프트 엔지니어링을 테크니컬 라이팅에 활용하는 방법’을 알아둘 만합니다. 이 글에서는 프롬프트 엔지니어링을 테크니컬 라이팅에 활용해야 하는 이유를 살펴보고요. 이 기술을 도입할 만한 테크니컬 라이팅 업무, 효과적인 테크니컬 라이팅용 프롬프트 요건, 테크니컬 라이팅용 프롬프트 예시를 알아보겠습니다.

여러분은 릴리즈 노트를 어떻게 작성하고 계신가요? 릴리즈 노트에 그저 ‘버그 수정’ 또는 ‘기능 개선’이라고만 쓰지는 않으신가요? 제품을 정기적으로 업데이트하다 보면 릴리즈 노트를 자칫 소홀히 작성할 우려가 있는데요. 릴리즈 노트를 관성에 기대어 성의 없이 쓰는 건 바람직하지 않습니다. 이는 릴리즈 노트가 소프트웨어 릴리즈 프로세스에서 중요한 역할을 하기 때문인데요. 릴리즈 노트는 제품 성과를 대내외에 공유하고, 사용자 또는 기업 내 구성원이 제품을 잘 이해하고 활용하도록 지원하며, 기업과 고객이 원활하게 소통하도록 돕습니다.

정리하면, 릴리즈 노트는 API 문서나 가이드처럼 독자(사용자, 기업 내 구성원 등)를 대상에 두고 작성하는 콘텐츠고요. 이에 독자 관점에서도 릴리즈 노트를 이해하기 쉽게, 도움이 되도록 써야 합니다. 엔지니어는 일상 업무로 릴리즈 노트를 종종 작성하는데요. 그렇다 보니 엔지니어 스스로 ‘난 릴리즈 노트 작성 방법을 잘 안다’라고 생각할 수도 있습니다. 이러한 생각은 자칫 독자, 그중에서도 사용자 입장을 더 고려하지 않고 엔지니어 관점에서만 릴리즈 노트를 쓰도록 이끌 수도 있는데요. 우리가 바람직한 릴리즈 노트 작성 방법을 꾸준히 공부하고, 관련 지식을 업데이트해야 할 이유입니다.

이 글에서는 릴리즈 노트를 효과적으로, 명확하게 써서 독자와 원활하게 소통하는 방법을 알아보려고 합니다. 먼저 릴리즈 노트의 개념과 중요성, 효과적인 릴리즈 노트 작성 방법을 살펴보고요. 아울러 인포그랩 프로덕트 팀의 릴리즈 노트 작성 방법을 소개하겠습니다.