강정일

Clova 기술 문서 작성 및 관리 업무를 맡고 있는 Technical Writer 강정일입니다.

C4 모델과 C4-PlantUML을 이용한 소프트웨어 구조 다이어그램 만들기

이번 글에선 Write the Docs Portland 2020 온라인 발표 중 하나를 소개하고 이 내용에 대해 이야기해볼까 합니다.

소프트웨어 구조를 파악할 때 글보다는 소프트웨어 구조 다이어그램과 같은 그림을 통해 훨씬 빠르게 이해한 경험이 많으실 겁니다. 그런데 소프트웨어 구조 다이어그램 작성에 익숙하지 않다면 막상 그리려고 해도 그리는 게 쉽지 않습니다. 어떤 도구를 써서 어떻게 시작해야 할지도 고민되고 그리기 시작한 뒤에도 이렇게 그리는 게 맞는지 자문할 때가 많으셨을 겁니다.

이번 글에서 소개할 발표는 Avi Flax 님의 Set your data free with model-based architecture diagramming 세션으로, 저와 여러분의 고민을 조금이나마 해소할 수 있을 것 같아 공유하려고 합니다.

테크니컬 라이팅 컨퍼런스: Write the Docs Prague 2018 방문기

안녕하세요. Clova 기술 문서 작성 및 관리 업무를 맡고 있는 Technical Writing 팀 강정일입니다.

Write the Docs(이하 WTD)는 커뮤니케이션, 문서, 그리고 사용자를 연구한 경험을 서로 공유하는 커뮤니티입니다. WTD는 특히 소프트웨어 산업과 관련된 분야에 좀 더 집중하고 있습니다. 이 커뮤니티는 매년 정기적으로 봄에는 미국 포틀랜드에서, 가을에는 체코 프라하에서 WTD 컨퍼런스를 열고 있는데요. WTD 컨퍼런스에서 참석자들은 각자가 문서 및 프로젝트를 관리하면서 얻은 경험을 공유하고, 좀 더 관심있는 주제가 있으면 토론도 하면서 새로운 사람과 뉴스를 접할 수 있는 기회를 가집니다.

이번 글에서는 제가 들었던 세션 중 가장 기억에 남는 두 세션과 각 세션에 대한 제 소감을 공유해드리려고 합니다.