documentation

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

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

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

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

그것이 알고 싶다 – 왜 개발자는 글을 못 쓸까?

개발자는 글을 못 쓰는 것일까? 아니, 개발자는 글을 안 쓰는 것일까? 아니, 개발자는 글을 쓰기 싫은 것일까?

저는 현직 테크니컬 라이터이자 전직 개발자로서 현장에서 겪은 경험을 바탕으로 이 현상을 심층 분석해 보려고 합니다. 단, 분석만입니다. 마치 매년 12월~1월에 서점에서 만나볼 수 있는 다양한 자기 계발서 마냥 상당히 이론적인 내용을 나눕니다. 누군가에겐 매우 따분한 이야기가 될 수 있겠지요. 누구나 머리로는 알고 있는 내용이지만 실천으로 이어질 가능성이 현저히 낮은 내용 말입니다.