본문 바로가기

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

WTD 애틀랜틱 2023 - Antora를 사용한 문서화 파이프라인

반응형

발표는 레드햇 테크니컬 라이터 Fabrice Flore가 진행했는데 운영 환경 관련 내용으로 바로 들어가서 기본 배경이 없다면 갑자기 저 사람은 누구인데 저건 또 무슨 이야기인가 싶습니다. Q&A에서도 그렇긴 하지만 뭔가 말을 좀 길게 하는 편이라서 어떤 이야기를 하고 싶은 건지 딱 명확하게 짚어내기가 어렵네요.

이 분 경력을 보면 2000년부터 개발자로 시작해서 테크니컬 라이터로 일하기 시작한 건 2019년부터입니다. 어떤 경로인지는 모르겠으나 이클립스 커미터로 합류하면서 문서화 엔지니어링 쪽에 참여하신 듯하구요. 그러면서 레드햇 쪽 일도 같이 한 것 같네요. 정확하게는 테크니컬 라이터보다는 도큐먼트 엔지니어 쪽이 좀 더 가까운 표현이 아닐까 싶습니다.

전반적인 내용은 콘텐츠 재사용에 대한 이야기입니다. 저장소에 콘텐츠 원본을 작성하고 Antora라는 솔루션을 사용해 필요한 콘텐츠를 조합해서 원하는 제품에 반영하는 형식입니다. Antora 자체가 "The multi-repository documentation site generator for tech writers who  writing in AsciiDoc."라는 타이틀을 가지고 있어서 여러 저장소를 다루는 것이 기본인데 이번 발표에서는 그걸 실제 제품에 어떻게 반영할 수 있는지 그 파이프라인에 대한 설명이네요.
여러 오픈소스 프로젝트를 참조하거나 여러 팀에서 관리하는 다른 저장소에서 가져와서 문서를 작성하는 경우 유용한 방법일 것 같습니다.
https://antora.org/

 

WTD 컨퍼런스 외에도 FOSDEM, Devconf 같은 컨퍼런스에서도 문서화 파이프라인에 대한 강연을 진행했습니다.
https://flore-thebault.com/slides/

 

https://youtu.be/XQpRqIUghQ0?si=H5KoD8iyeH3nro5I

 

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

 

DocumentationPipeline

 

www.flickr.com

 

728x90