goorm
구름은 ‘모두가 개발자가 된다’는 비전으로 ‘개발자 성장 중심’ 생태계를 만들어 나가고 있습니다. AI·SW 교육 플랫폼 구름EDU, 알고리즘 문제 풀이 서비스 구름LEVEL, 코딩 테스트 플랫폼 구름DEVTH, 클라우드 통합 개발 환경 구름IDE 서비스를 제공하고 있어요.
문서 엔지니어링 : 기술 문서에도 엔지니어링이 필요하다
기술 문서는 API/SDK 가이드, 사용자 매뉴얼, 릴리즈 노트 등을 말해요. ‘문서 엔지니어링’은 기술로 문서 생명주기의 전 과정을 개선하는 분야에요. 문서 작성, 편집, 저장, 버전관리, 배포 등 일련의 프로세스 전반이 일관되고 체계적으로 관리하는 방법을 설계하고 구현하죠.
기술 문서는 제품이나 서비스에 끼치는 영향을 간과하기 쉬워요. 제품 개발 일정이나 다른 우선순위에 밀려 뒷전이 되기 쉽죠.
한 설문조사에 따르면 API 사용자가 중요하게 생각하는 요소의 2위가 ‘문서 품질’이었어요. API 서비스 도입을 보류하게 만드는 요소로, ‘문서가 부족한 경우’가 1위를 차지했을 만큼 중요하죠.
이처럼 중요한 기술 문서를 잘 작성하는 것 못지않게 중요한 것이 ‘관리’에요. 문서 배포나 작성 과정에서 스타일이나 구조가 깨지거나, 문서를 이전으로 되돌리는 데 문제를 겪거나, 다국어 지원에 문제를 겪곤 해요. 또 최신 문서를 제때 배포하기 위해서는 체계적인 기술 문서 생산, 편집, 배포 프로세스가 필요하죠.
이에 11월 COMMIT에서는 문서를 코드처럼 관리하는 Docs as Code 개념으로 기술 문서를 효율적으로 관리하는 라인 플러스(LINE Plus, 이하 라인)의 전정은 도큐먼트 엔지니어를 모셨어요.
라인은 기술 문서를 어떻게 작성, 편집, 생산 관리했었고 어떤 문제를 겪었는지, 이러한 문제를 어떻게 해결했고, 현재는 어떤 도구와 프로세스를 확립했는지 11월 COMMIT에서 들려드릴게요.
들려 드릴 이야기
- 문서 엔지니어링 도입 과정
- 기술 문서를 소스 코드처럼 취급하고 관리하는 Docs as code
- 라인의 문서 작성, 편집, 배포 관리 도구와 프로세스
이런 분께 추천해요
💁♀️ 기술 문서의 생명주기 전반에서 어려움을 겪는 분
💁♂️ 라인의 기술 문서 배포 시스템과 도구, 프로세스가 궁금한 분
💁 문서화 과정에서 반복되는 단순 작업을 줄이고 싶은 분
LINE Plus 도큐먼트 엔지니어
소설가를 꿈꾸다가 컴퓨터 공학도가 된 바람에 문학과 공학 양쪽에 관심과 애정이 있습니다. 지금은 문서 솔루션 및 기술 문서 작성 기법을 고민하는 도큐먼트 엔지니어로 일합니다.
현) LINE Plus 도큐먼트 엔지니어
전) LG전자 테크니컬 라이터 & 에반젤리스트
전) 한국항공우주연구원 시스템 개발자
세션 소개
1부(19:00 ~ 19:10) : 구름과 COMMIT 소개
2부(19:10 ~ 20:00) : 기술 문서에도 엔지니어링이 필요하다 – 전정은
3부(20:00 ~ 20:30) : Q&A
수요일에 만나요
COMMIT에 참석하면
- Q&A 세션에 참여해 궁금한 점을 해결할 수 있어요.
- 간단한 핑거 푸드와 음료를 제공해 드려요.
참고해 주세요
- 참가 신청은 11월 22일 금요일 17:00에 참가 신청이 마감됩니다.
- 참가가 확정된 분에게는 신청 마감 당일 이메일과 문자로 알려드립니다.
- 오프라인 참석자는 추첨을 통해 선정됩니다.
- 참석 확정 후 당일 불참하시면 다음 오프라인 참석 선정에 불이익이 있습니다.
- 본 행사는 양도할 수 없으며, 신청하신 본인만 참석할 수 있습니다.
- 본 행사는 녹음, 녹화, 라이브 스트리밍을 허용하지 않습니다.
- 참석 현황에 따라 약 10분 정도 늦게 시작할 수 있습니다.
- 주차는 지원하지 않습니다. 대중교통을 이용해 주세요.
- 기타 행사 관련 문의는 [COMMIT 채팅 상담]으로 문의해 주세요.
FAQ
발표 자료는 공유되나요?
11월 COMMIT 발표 자료는 만족도 조사 이후 이메일로 발송 드릴 예정입니다.
다음 COMMIT은 언제 열리나요?
COMMIT은 월에 한 번 새로운 주제로 수요일에 열리고 있습니다. 자세한 일정은 구름 기술 블로그나 COMMIT 소식지(메일)에서 알려드려요.
가장 먼저 COMMIT 소식을 받아보고 싶으시면 📎이름과 이메일 주소를 남겨주세요.
COMMIT
COMMIT은 COMMUNICATION과 IT의 합성어로 한 달에 한 번 수요일에 기술, 개발, 성장, 조직 문화 등에 관한 이야기를 나눕니다.
개발자에게 커밋(commit)은 변경 사항을 기록하는 작업입니다. 개발자가 소스 코드를 커밋하듯 IT 업계를 이루는 분들의 역량을 COMMIT 합니다. COMMIT은 IT 지식과 경험을 공유하고 싶은 모든 분께 열려 있어요.
COMMIT은 고용노동부가 함께하는 K-Digital Platform 사업의 일환으로, IT 지식을 갖추고자 하는 분들을 위한 무료 세미나입니다.
지난 COMMIT이 궁금하다면?
이전 COMMIT을 확인해 보세요. 오직 COMMIT에서만 만나볼 수 있습니다.
구름 채용 바로가기
구름에서 채용 중인 포지션을 확인하고 싶으시다면, 구름 채용 사이트에서 확인해 주세요
