본문 바로가기

테크니컬 라이팅

API The Docs 2020 - 문서 내 사용되는 코드 샘플 자동화

반응형

Patrick Hammond은 Adyen라는 페이먼트 관련 기업의 프로젝트 매니저입니다. 

링크드인 사이트에 가보면 Doc Ops를 담당하고 있다고 본인을 설명하고 있습니다. 영상 중에서도 나오는 표현이긴 합니다. 

WTD 사이트에서도 https://www.writethedocs.org/guide/doc-ops/ 라는 페이지에서 설명하고 있긴 한데 본인 소개에 사용하는 건 처음 본 것 같습니다.

 

Adyen 같은 경우에는 비슷하지만 조금씩 다른 작은 샘플 코드를 작성하는 것이 이슈였다고 합니다. 그리고 7개 언어를 지원하면서(아마 주석 등에) 실제 작성해야 하는 코드 샘플이 계속 늘어나게 되는 구조입니다. 그래서 코드 샘플을 분석해서 자동으로 언어별 코드 샘플을 생성해주는 프로세스를 개발했다고 합니다.

 

문서 자동화는 아니지만, 문서 내에서 사용되는 코드 샘플의 자동 생성에 대한 주제이고 문서팀에서 관리하는 샘플 코드에 대한 이야기라 비슷한 상황이라면 내용을 살펴보는 것이 좋을 듯합니다.

 

https://pronovix.com/event/api-docs-virtual-2020/patrick-hammond

 

Patrick Hammond - Let writers write: Automating the boring stuff for our docs team

DocOps involves facilitating a content flow that is collaborative, agile, continuous, enables reuse; it helped create a culture that serves documentation in a way that understands how techwriters work. Presented at API the Docs Virtual 2020 on 4 November.

pronovix.com

자체적으로 마크다운, 깃허브 기반의 CMS 도구를 만들었다는 것 같은데, 어떤 식으로 만들었는지 궁금하긴 합니다.

728x90